Add new API version for Microsoft.Resources/changes (2023-03-01-preview) #23272
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @dhu5432 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @dhu5432 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| changes.json | 2023-03-01-preview(7c9372a) | 2022-05-01(main) |
| changes.json | 2023-03-01-preview(7c9372a) | 2022-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is removing enum value(s) 'Create' from the old version. New: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L310:9 Old: Microsoft.Resources/preview/2022-03-01-preview/changes.json#L305:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-changes-2023-03-01-preview | package-changes-2023-03-01-preview(7c9372a) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L261 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Operations API must be implemented for 'Microsoft.Resources'. Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L1 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L37 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L94 |
|
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L349 |
|
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L388 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Resources/preview/2023-03-01-preview/changes.json#L173 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 2 Errors, 0 Warnings failed [Detail]
Tag package-changes-2023-03-01-preview; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 2, untested: 0, failed: 2, passed: 0
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: InvalidResourceNamespace, errorMessage: The resource namespace 'resourceql3502' is invalid. Source: runtime OperationId: Changes_List |
|
statusCode: 404, errorCode: InvalidResourceNamespace, errorMessage: The resource namespace 'resourceql3502' is invalid. Source: runtime OperationId: Changes_Get |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
CI-MissingBaseCommit
new-api-version
ReadyForApiTest
|
Hi, @dhu5432, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Mar 23, 2023
This was referenced Mar 23, 2023
XiaofeiCao
added
the
Approved-OkToMerge
XiaofeiCao
approved these changes
Apr 4, 2023
This was referenced Apr 4, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…ew) (Azure#23272) * Base Commit. 2022-05-01 version for changes * Changes for new api version 2023-03-01-preview * Model as enum * Forgot to include type * isTruncated to string * Change isTruncated to bool
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM API Information (Control Plane)
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply 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.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.