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.

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

[Test] New API version for Microsoft.Resources stable/2022-09-01 #3689

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[Test] New API version for Microsoft.Resources stable/2022-09-01 #3689

wants to merge 3 commits into from

Conversation

ankhyk
Copy link

@ankhyk ankhyk commented Nov 14, 2023

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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-test openapi-pipeline-app-test
Copy link

Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️❌Breaking Change(Cross-Version): 6 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
resources.json 2022-09-01(60736f8) 2021-04-01(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
❌ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.Resources/stable/2022-09-01/resources.json#L4360:11
❌ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.Resources/stable/2022-09-01/resources.json#L4416:11
❌ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.Resources/stable/2022-09-01/resources.json#L4497:11
❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
New: Microsoft.Resources/stable/2022-09-01/resources.json#L4330:7
Old: Microsoft.Resources/stable/2021-04-01/resources.json#L4330:7
❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
New: Microsoft.Resources/stable/2022-09-01/resources.json#L4386:7
Old: Microsoft.Resources/stable/2021-04-01/resources.json#L4376:7
❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
New: Microsoft.Resources/stable/2022-09-01/resources.json#L4479:7
Old: Microsoft.Resources/stable/2021-04-01/resources.json#L4451:7
️️✔️LintDiff succeeded [Detail] [Expand] 
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.6) new version base version
default default(60736f8) default(main)
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand] 
Validation passes for Lint(RPaaS).
️❌Avocado: 32 Errors, 0 Warnings failed [Detail]

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

Rule Message
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/CalculateTemplateHash.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/CreateResourceGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/DeleteTagsResource.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/DeleteTagsSubscription.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/ExportResourceGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/ExportResourceGroupWithFiltering.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/ForceDeleteVMsInResourceGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetNamedProviderAtTenant.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetProvider.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetProviderPermissions.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetProviderResourceTypes.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetProviders.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetTagsResource.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/GetTagsSubscription.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PatchTagsResource.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PatchTagsSubscription.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PostDeploymentWhatIfOnManagementGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PostDeploymentWhatIfOnResourceGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PostDeploymentWhatIfOnSubscription.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PostDeploymentWhatIfOnTenant.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentAtManagementGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentAtScope.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentAtTenant.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentResourceGroup.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/resources/resource-manager/readme.md
json: stable/2022-09-01/examples/PutTagsResource.json
️❌ModelValidation: 150 Errors, 0 Warnings failed [Detail]

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

Rule Message
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L38:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L69:17
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L103:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L189:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L223:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L255:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L308:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L342:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L392:17
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L423:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L503:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L534:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L563:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L675:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtTenantScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L706:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L753:17
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L787:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L873:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L907:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L939:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1057:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtManagementGroupScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1091:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1141:17
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1175:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1261:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1295:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1327:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1445:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtSubscriptionScope.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1479:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_Delete.
Url: Microsoft.Resources/stable/2022-09-01/resources.json#L1529:17
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️~[NotRequired_Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[NotRequired_Staging] TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand] 
Validation passed for PoliCheck.
️️✔️[NotRequired_Staging] PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️️✔️[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️[NotRequired_Staging] SDK Track2 Validation succeeded [Detail] [Expand] 
Validation passes for SDKTrack2Validation
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023 •
edited
Loading

Swagger Generation Artifacts

️🔄[NotRequired_Staging] ApiDocPreview inProgress [Detail]
️❌[NotRequired_Staging] SDK Breaking Change Tracking failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-python-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-java warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/resources/armchanges Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armdeploymentscripts Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armfeatures Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armlinks Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armlocks Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armmanagedapplications Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armpolicy Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armresources Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armsubscriptions Create ApiView failed. Please ask PR assignee for help
Go sdk/resourcemanager/resources/armtemplatespecs Create ApiView failed. Please ask PR assignee for help
Java azure-resourcemanager-resources-generated Create ApiView failed. Please ask PR assignee for help
.Net Azure.ResourceManager Create ApiView failed. Please ask PR assignee for help
.Net Azure.ResourceManager.Resources Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-changes Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-features Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-links Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-locks Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-managedapplications Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-policy Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-resources-subscriptions Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-resources Create ApiView failed. Please ask PR assignee for help
JavaScript @azure/arm-templatespecs Create ApiView failed. Please ask PR assignee for help

This was referenced Nov 14, 2023
Draft
Draft
Draft
Draft
Draft
Draft
Draft
Draft
Draft
Draft
This was referenced Nov 14, 2023
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Nov 14, 2023
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
ARMChangesRequested ARMReview BreakingChangeReviewRequired CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-MissingBaseCommit new-api-version resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ankhyk @AzureRestAPISpecReview