Skip to content

Adding 2021-03-01 api-version to Template Specs (no changes over last preview spec) #14006

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

Adding 2021-03-01 api-version to Template Specs (no changes over last preview spec) #14006

wants to merge 3 commits into from

Conversation

@stuartko
Copy link
Contributor

@stuartko stuartko commented Apr 19, 2021 •
edited
Loading

This change copies 2021-03-01-preview to stable version 2021-03-01 and updates the suffix as necessary. It has no model changes when compared to 2021-03-01-preview. We are also intentionally not updating the readme.md used for generating the SDK for this version because we want to release the SDK at a later date (following the 2021-03-01-preview SDK release).

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. May 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. May 2021
  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-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 19, 2021 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
The following errors/warnings exist before current PR submission:

Only 10 items are listed, please refer to log for more details.

Rule Message
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4021 - DescriptionAndTitleMissing 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L824
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: TemplateSpecsPatch
Location: Microsoft.Resources/stable/2021-03-01/templateSpecs.json#L377
️️✔️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

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
"tag":"package-templatespecs-2021-03",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
"tag":"package-templatespecs-2021-03",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
"tag":"package-templatespecs-2021-03",
"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.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented Apr 19, 2021

Hi, @stuartko 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 19, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 01a1afa644d1ca0c0c00c97156687610f77e9724. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/resources/resource-manager/readme.md
    • ️✔️@azure/arm-features [View full logs]  [Preview 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/featureClient.js → ./dist/arm-features.js...
cmderr	[npmPack] created ./dist/arm-features.js in 167ms
    • ️✔️@azure/arm-links [View full logs]  [Preview 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/managementLinkClient.js → ./dist/arm-links.js...
cmderr	[npmPack] created ./dist/arm-links.js in 183ms
    • ️✔️@azure/arm-locks [View full logs]  [Preview 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/managementLockClient.js → ./dist/arm-locks.js...
cmderr	[npmPack] created ./dist/arm-locks.js in 237ms
    • ️✔️@azure/arm-managedapplications [View full logs]  [Preview 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/applicationClient.js → ./dist/arm-managedapplications.js...
cmderr	[npmPack] created ./dist/arm-managedapplications.js in 286ms
    • ️✔️@azure/arm-policy [View full logs]  [Preview 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/policyClient.js → ./dist/arm-policy.js...
cmderr	[npmPack] created ./dist/arm-policy.js in 399ms
    • ️✔️@azure/arm-resources [View full logs]  [Preview 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/resourceManagementClient.js → ./dist/arm-resources.js...
cmderr	[npmPack] created ./dist/arm-resources.js in 565ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 01a1afa644d1ca0c0c00c97156687610f77e9724. 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-resource [View full logs]  [Preview SDK Changes] 
      info	[Changelog]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 01a1afa644d1ca0c0c00c97156687610f77e9724. Schema Automation 14.0.0 
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
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
cmderr	[generateScript.sh] (node:2828) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2020-06-01/Microsoft.Resources.json'
cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
cmderr	[generateScript.sh] (node:2828) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
cmderr	[generateScript.sh] (node:2828) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
    • ️✔️resources [View full logs]  [Preview Schema Changes]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 01a1afa644d1ca0c0c00c97156687610f77e9724. 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-04-20 06:12:57 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-resources-generated"
cmderr	[generate.py] 2021-04-20 06:12:57 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-04-20 06:12:57 INFO autorest --version=3.1.3 --use=@autorest/[email protected] --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/resources/azure-resourcemanager-resources-generated --java.namespace=com.azure.resourcemanager.resources.generated --tag=package-resources-2021-01  --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/resources/resource-manager/readme.md
cmderr	[generate.py] 2021-04-20 06:13:39 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-04-20 06:13:39 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-04-20 06:13:39 INFO [POM][Skip] pom already has module azure-resourcemanager-resources-generated
cmderr	[generate.py] 2021-04-20 06:13:39 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-04-20 06:13:39 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-04-20 06:13:39 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-resources-generated [View full logs]  [Preview SDK Changes] 
      cmderr	[Inst] 2021-04-20 06:16:42 DEBUG Got artifact_id: azure-resourcemanager-resources-generated
cmderr	[Inst] 2021-04-20 06:16:42 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-04-20 06:16:42 DEBUG Got artifact: azure-resourcemanager-resources-generated-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-04-20 06:16:42 DEBUG Got artifact: azure-resourcemanager-resources-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-04-20 06:16:42 DEBUG Match jar package: azure-resourcemanager-resources-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-04-20 06:16:42 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14006/azure-sdk-for-java/azure-resourcemanager-resources-generated/azure-resourcemanager-resources-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-resources-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-resources-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-resources-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 19, 2021

    [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-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 19, 2021

    Hi @stuartko, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    This was referenced Apr 19, 2021
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    @raych1
    Copy link
    Member

    raych1 commented Apr 20, 2021

    @stuartko , can you fix the avocado check errors?

    @stuartko
    Copy link
    Contributor Author

    stuartko commented Apr 20, 2021

    @raych1 : Done

    @raych1
    Copy link
    Member

    raych1 commented Apr 21, 2021

    @stuartko , can you go through ARM API Review Checklist in first comment and check on the proper items? This PR needs ARM review.

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 21, 2021

    Hi, @stuartko your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @raych1

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 21, 2021
    @stuartko
    Copy link
    Contributor Author

    stuartko commented Apr 21, 2021

    @raych1 Done. FYI to ARM Review, this contains no changes over the previous preview version other than the api-version itself.

    @majastrz majastrz added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 21, 2021
    majastrz
    majastrz approved these changes Apr 21, 2021
    View reviewed changes
    Copy link
    Member

    @majastrz majastrz left a comment

    Choose a reason for hiding this comment

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

    This is identical to the previously approved API except for the suffix in the version itself. Signed off from ARM side.

    @stuartko
    Copy link
    Contributor Author

    stuartko commented Apr 21, 2021

    Temporarily adding DoNotMerge tag, as we have an update coming.

    @stuartko stuartko added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Apr 21, 2021
    @stuartko stuartko mentioned this pull request Apr 22, 2021
    Merged
    26 tasks
    @stuartko
    Copy link
    Contributor Author

    stuartko commented Apr 22, 2021

    Closing due to new PR #14065 with an additional version bump (requested for easier diffing).

    @stuartko stuartko closed this Apr 22, 2021
    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @stuartko. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    @JackTn JackTn deleted the users/stuartko/Apr21_TemplateSpecsGAVersion branch July 5, 2022 01:24
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @majastrz majastrz majastrz approved these changes

    Assignees

    @raych1 raych1

    Labels

    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go DoNotMerge <valid label in PR review process> use to hold merge after approval

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    5 participants

    @stuartko @raych1 @JackTn @majastrz