Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mgmt, video analyzer java, update readme and description #14526

Conversation

weidongxu-microsoft
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft commented May 24, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @weidongxu-microsoft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 24, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"videoanalyzer/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"videoanalyzer/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"videoanalyzer/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 24, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-videoanalyzer - 1.0.0b1
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from af172bd. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-05-25 01:37:14 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-videoanalyzer;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-05-25 01:37:14 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-05-25 01:37:14 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.29 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/videoanalyzer/azure-resourcemanager-videoanalyzer --java.namespace=com.azure.resourcemanager.videoanalyzer   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/videoanalyzer/resource-manager/readme.md
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-videoanalyzer
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [POM][Skip] pom already has module azure-resourcemanager-videoanalyzer
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [POM][Skip] pom already has module sdk/videoanalyzer
      cmderr	[generate.py] 2021-05-25 01:37:47 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-videoanalyzer [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-05-25 01:40:26 DEBUG Got artifact_id: azure-resourcemanager-videoanalyzer
      cmderr	[Inst] 2021-05-25 01:40:26 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-25 01:40:26 DEBUG Got artifact: azure-resourcemanager-videoanalyzer-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-05-25 01:40:26 DEBUG Match jar package: azure-resourcemanager-videoanalyzer-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-05-25 01:40:26 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14526/azure-sdk-for-java/azure-resourcemanager-videoanalyzer/azure-resourcemanager-videoanalyzer-1.0.0-beta.2.jar\" -o azure-resourcemanager-videoanalyzer-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-videoanalyzer -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-videoanalyzer-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from af172bd. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/videoanalyzer/mgmt/2021-05-01-preview/videoanalyzer [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Const `AccessPolicyRoleReader` has been removed
      info	[Changelog] - Const `AccessPolicyRsaAlgoRS512` has been removed
      info	[Changelog] - Const `CheckNameAvailabilityReasonAlreadyExists` has been removed
      info	[Changelog] - Const `TypeTypeAuthenticationBase` has been removed
      info	[Changelog] - Const `MetricAggregationTypeCount` has been removed
      info	[Changelog] - Const `CreatedByTypeKey` has been removed
      info	[Changelog] - Const `TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerRsaTokenKey` has been removed
      info	[Changelog] - Const `CreatedByTypeManagedIdentity` has been removed
      info	[Changelog] - Const `AccessPolicyRsaAlgoRS256` has been removed
      info	[Changelog] - Const `AccountEncryptionKeyTypeCustomerKey` has been removed
      info	[Changelog] - Const `CreatedByTypeUser` has been removed
      info	[Changelog] - Const `MetricAggregationTypeTotal` has been removed
      info	[Changelog] - Const `AccessPolicyEccAlgoES384` has been removed
      info	[Changelog] - Const `AccessPolicyRsaAlgoRS384` has been removed
      info	[Changelog] - Const `ActionTypeInternal` has been removed
      info	[Changelog] - Const `AccessPolicyEccAlgoES512` has been removed
      info	[Changelog] - Const `CreatedByTypeApplication` has been removed
      info	[Changelog] - Const `CheckNameAvailabilityReasonInvalid` has been removed
      info	[Changelog] - Const `VideoTypeArchive` has been removed
      info	[Changelog] - Const `TypeTypeMicrosoftVideoAnalyzerJwtAuthentication` has been removed
      info	[Changelog] - Const `MetricAggregationTypeAverage` has been removed
      info	[Changelog] - Const `TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerEccTokenKey` has been removed
      info	[Changelog] - Const `AccessPolicyEccAlgoES256` has been removed
      info	[Changelog] - Const `AccountEncryptionKeyTypeSystemKey` has been removed
      info	[Changelog] - Const `TypeBasicTokenKeyTypeTokenKey` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `TypeMicrosoftVideoAnalyzerRsaTokenKey`
      info	[Changelog] - New const `RS512`
      info	[Changelog] - New const `RS384`
      info	[Changelog] - New const `CustomerKey`
      info	[Changelog] - New const `Application`
      info	[Changelog] - New const `User`
      info	[Changelog] - New const `Count`
      info	[Changelog] - New const `ES512`
      info	[Changelog] - New const `TypeTokenKey`
      info	[Changelog] - New const `Internal`
      info	[Changelog] - New const `AlreadyExists`
      info	[Changelog] - New const `TypeMicrosoftVideoAnalyzerJwtAuthentication`
      info	[Changelog] - New const `Archive`
      info	[Changelog] - New const `TypeAuthenticationBase`
      info	[Changelog] - New const `RS256`
      info	[Changelog] - New const `TypeMicrosoftVideoAnalyzerEccTokenKey`
      info	[Changelog] - New const `SystemKey`
      info	[Changelog] - New const `ES384`
      info	[Changelog] - New const `Key`
      info	[Changelog] - New const `Total`
      info	[Changelog] - New const `ManagedIdentity`
      info	[Changelog] - New const `Average`
      info	[Changelog] - New const `Reader`
      info	[Changelog] - New const `ES256`
      info	[Changelog] - New const `Invalid`
      info	[Changelog]
      info	[Changelog] Total 25 breaking change(s), 25 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from af172bd. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/videoanalyzer/resource-manager/readme.md
    • ️✔️@azure/arm-videoanalyzer [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/videoAnalyzer.js → ./dist/arm-videoanalyzer.js...
      cmderr	[npmPack] created ./dist/arm-videoanalyzer.js in 390ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from af172bd. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from af172bd. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/videoanalyzer/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'VideoAnalyzerProperties' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'ProxyResource' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'ProxyResource' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'VideoAnalyzerProperties' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (): Operation Update has already existed in group! Skip split!
      cmdout	[Autorest] WARNING (): Operation Update has already existed in group! Skip split!
      cmdout	[Autorest] WARNING (): Operation Update has already existed in group! Skip split!
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /AccessPolicies/put/Register access policy entity.
      cmderr	[Autorest]     - name: /AccessPolicies/get/Gets an access policy entity.
      cmderr	[Autorest]     - name: /AccessPolicies/get/Lists access policy entities.
      cmderr	[Autorest]     - name: /AccessPolicies/patch/Update access policy entity.
      cmderr	[Autorest]     - name: /AccessPolicies/delete/Deletes an access policy entity.
      cmderr	[Autorest]     - name: /EdgeModules/put/Registers an edge module.
      cmderr	[Autorest]     - name: /EdgeModules/get/Gets edge module registration.
      cmderr	[Autorest]     - name: /EdgeModules/get/Lists the registered edge modules.
      cmderr	[Autorest]     - name: /EdgeModules/post/Generate the Provisioning token for an edge module registration.
      cmderr	[Autorest]     - name: /EdgeModules/delete/Deletes an edge module registration.
      cmderr	[Autorest]     - name: /VideoAnalyzers/put/Create a Video Analyzer account
      cmderr	[Autorest]     - name: /VideoAnalyzers/get/Get a Video Analyzer account by name
      cmderr	[Autorest]     - name: /VideoAnalyzers/get/List all Video Analyzer accounts
      cmderr	[Autorest]     - name: /VideoAnalyzers/get/List all Video Analyzer accounts by subscription
      cmderr	[Autorest]     - name: /VideoAnalyzers/patch/Update a Video Analyzer accounts
      cmderr	[Autorest]     - name: /VideoAnalyzers/post/Synchronizes Storage Account Keys
      cmderr	[Autorest]     - name: /VideoAnalyzers/delete/Delete a Video Analyzer account
      cmderr	[Autorest]     - name: /Videos/put/Register video entity.
      cmderr	[Autorest]     - name: /Videos/get/Gets a video entity.
      cmderr	[Autorest]     - name: /Videos/get/Lists video entities.
      cmderr	[Autorest]     - name: /Videos/patch/Update video entity.
      cmderr	[Autorest]     - name: /Videos/post/Generate a streaming token for media endpoint authorization.
      cmderr	[Autorest]     - name: /Videos/delete/Deletes a video entity.
      cmderr	[Autorest] --------------------------------------------------------
    • ️✔️videoanalyzer [View full logs]  [Release Azure CLI Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @weidongxu-microsoft weidongxu-microsoft marked this pull request as ready for review May 24, 2021 04:14
    @@ -10,6 +10,9 @@ namespace: com.microsoft.azure.management.videoanalyzer
    license-header: MICROSOFT_MIT_NO_CODEGEN
    payload-flattening-threshold: 2
    output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-videoanalyzer

    service-name: Video Analyzer
    description: 'Azure Video Analyzer provides a platform for you to build intelligent video applications that span the edge and the cloud.'
    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    preferable this can be specified in readme.md

    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    As ask from service, moved to readme.md

    @weidongxu-microsoft weidongxu-microsoft changed the title mgmt video analyzer java readme mgmt, video analyzer java, update readme and description May 24, 2021
    @ArcturusZhang
    Copy link
    Member

    @weidongxu-microsoft please feel free to merge by yourself when this is ready

    @weidongxu-microsoft
    Copy link
    Member Author

    @ArcturusZhang

    Sure. Thanks. I will likely merge it tomorrow.

    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants