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

Add configuration to generate AppPlatform SDK for API version 2021-06-01-preview #14301

Merged
merged 3 commits into from
Jun 8, 2021

Conversation

allxiao
Copy link
Member

@allxiao allxiao commented May 7, 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, update SDK generating configuration to generate versioned SDK files for api-version 2021-03-03-preview
  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.
    June 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    N/A
  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
    • SDK of Ruby
    • 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, @allxiao 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 7, 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 BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) 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
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 7, 2021

    Swagger Generation Artifacts

    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 887d142. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      Resource not accessible by integration
      HttpError: Resource not accessible by integration
          at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit/request@5.4.15/node_modules/@octokit/request/dist-node/index.js:68:23
          at processTicksAndRejections (internal/process/task_queues.js:95:5)
          at async workflowPkgUpdatePR (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:330:21)
          at async Object.exports.workflowPkgMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:41:5)
          at async workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
          at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
          at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️Az.AppPlatform [View full logs
      error	Fatal error: Resource not accessible by integration
      error	The following packages are still pending:
      error		Az.AppPlatform
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 887d142. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model MetricDimension has a new parameter to_be_exported_for_shoebox
      info	[Changelog]   - Model UserSourceInfo has a new parameter custom_container
      info	[Changelog]   - Model DeploymentSettings has a new parameter resource_requests
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 887d142. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model DeploymentSettings has a new parameter resource_requests
      info	[Changelog]   - Model UserSourceInfo has a new parameter custom_container
      info	[Changelog]   - Model MetricDimension has a new parameter to_be_exported_for_shoebox
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 887d142. 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-06-08 08:19:55 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-appplatform-generated"
      cmderr	[generate.py] 2021-06-08 08:19:55 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-06-08 08:19:55 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/appplatform/azure-resourcemanager-appplatform-generated --java.namespace=com.azure.resourcemanager.appplatform.generated   --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/appplatform/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-08 08:20:29 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-06-08 08:20:29 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-08 08:20:29 INFO [POM][Skip] pom already has module azure-resourcemanager-appplatform-generated
      cmderr	[generate.py] 2021-06-08 08:20:29 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-08 08:20:29 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-08 08:20:29 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-appplatform-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-08 08:22:50 DEBUG Got artifact_id: azure-resourcemanager-appplatform-generated
      cmderr	[Inst] 2021-06-08 08:22:50 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-08 08:22:50 DEBUG Got artifact: azure-resourcemanager-appplatform-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-06-08 08:22:50 DEBUG Got artifact: azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-06-08 08:22:50 DEBUG Match jar package: azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-06-08 08:22:50 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14301/azure-sdk-for-java/azure-resourcemanager-appplatform-generated/azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-appplatform-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 887d142. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/appplatform/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.AppPlatform [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 887d142. 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.6.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/appplatform/resource-manager/readme.md
    • ️✔️@azure/arm-appplatform [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/appPlatformManagementClient.js → ./dist/arm-appplatform.js...
      cmderr	[npmPack] created ./dist/arm-appplatform.js in 540ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 887d142. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appplatform/mgmt/2020-07-01/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Inbound`
      info	[Changelog] - New const `Outbound`
      info	[Changelog] - New function `PossibleTrafficDirectionValues() []TrafficDirection`
      info	[Changelog] - New function `RequiredTraffic.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New struct `RequiredTraffic`
      info	[Changelog] - New field `RequiredTraffics` in struct `NetworkProfile`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 8 additive change(s).
      info	[Changelog]
    • ️✔️preview/appplatform/mgmt/2021-06-01-preview/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/appplatform/mgmt/2020-11-01-preview/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/appplatform/mgmt/2019-05-01-preview/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Inbound`
      info	[Changelog] - New const `Outbound`
      info	[Changelog] - New const `DeploymentResourceProvisioningStateDeleting`
      info	[Changelog] - New const `Deleting`
      info	[Changelog] - New function `PossibleTrafficDirectionValues() []TrafficDirection`
      info	[Changelog] - New function `RequiredTraffic.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New struct `RequiredTraffic`
      info	[Changelog] - New field `RequiredTraffics` in struct `NetworkProfile`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog] - New field `Sku` in struct `DeploymentResource`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 11 additive change(s).
      info	[Changelog]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 887d142. 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
    • ️✔️appplatform [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @raych1
    Copy link
    Member

    raych1 commented May 7, 2021

    @weidongxu-microsoft @ArcturusZhang @msyyc , can you review the readme changes?

    @weidongxu-microsoft
    Copy link
    Member

    Java is fine. Actually for track2 we no longer require changes in readme.java.md (as no multiapi support).

    @allxiao allxiao closed this May 10, 2021
    @allxiao allxiao reopened this May 10, 2021
    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    Approved for readme.go.md changes

    @allxiao allxiao changed the title Add configuration to generate AppPlatform SDK for API version 2021-03-03-preview Add configuration to generate AppPlatform SDK for API version 2021-06-01-preview May 12, 2021
    @allxiao
    Copy link
    Member Author

    allxiao commented May 13, 2021

    Hi team, are we still waiting for any other approvals? If not, could you please help to merge this PR?
    Thanks,

    @raych1
    Copy link
    Member

    raych1 commented May 19, 2021

    Hi team, are we still waiting for any other approvals? If not, could you please help to merge this PR?
    Thanks,

    @weidongxu-microsoft @msyyc , can you review the Java/Python readme changes?

    @ghost
    Copy link

    ghost commented Jun 6, 2021

    Hi, @allxiao. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @allxiao
    Copy link
    Member Author

    allxiao commented Jun 7, 2021

    Hi @raych1 , do we still need to wait for others' approval for this PR?

    @raych1
    Copy link
    Member

    raych1 commented Jun 8, 2021

    Hi @raych1 , do we still need to wait for others' approval for this PR?

    @msyyc, can you review the python readme change?

    @msyyc
    Copy link
    Member

    msyyc commented Jun 8, 2021

    For python, the configuration is expected.

    @raych1 raych1 merged commit 887d142 into Azure:master Jun 8, 2021
    This was referenced Jun 8, 2021
    @allxiao
    Copy link
    Member Author

    allxiao commented Jun 8, 2021

    thanks team!

    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    …-01-preview (Azure#14301)
    
    * Add configuration to generate AppPlatform SDK for API version 2021-03-03-preview
    
    * Update AutoRest configuration after api-version change in Azure#14323
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …-01-preview (Azure#14301)
    
    * Add configuration to generate AppPlatform SDK for API version 2021-03-03-preview
    
    * Update AutoRest configuration after api-version change in Azure#14323
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants