Adding a new stable API-version 2023-05-01 #23541
Merged
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, @Shashank1306s 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 |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| dataprotection.json | 2023-05-01(0b4cf82) | 2023-01-01(main) |
| dataprotection.json | 2023-05-01(0b4cf82) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-05 | package-2023-05(0b4cf82) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The parameters:operationId,location should be kept in the same order as they present in the path. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L64 |
|
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L94 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L184 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L328 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L375 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L440 |
|
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L467 |
|
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L526 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L544 |
|
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L580 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L761 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L809 |
|
The resource name parameter 'backupPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L809 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L969 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1017 |
|
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1017 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1064 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1112 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1139 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1205 |
|
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1205 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1206 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1281 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1282 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1354 |
|
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1354 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1360 |
|
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1394 |
|
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1394 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-05-01/dataprotection.json#L1411 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DataProtection' for api version '2023-05-01'. The supported api-versions are '2020-01-01-alpha, 2021-02-01-preview, 2021-06-01-preview, 2021-01-01, 2021-07-01, 2021-10-01-preview, 2021-12-01-preview, 2022-01-01, 2022-02-01-preview, 2022-03-01, 2022-04-01, 2022-05-01, 2022-09-01-preview, 2022-10-01-preview, 2022-11-01-preview, 2022-12-01, 2023-01-01'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️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
ARMReview
CI-MissingBaseCommit
new-api-version
ReadyForApiTest
|
Hi, @Shashank1306s, 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 |
|
Hi, @Shashank1306s your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
This was referenced Apr 13, 2023
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@Shashank1306s I notice that our API readiness check failed https://github.com/Azure/azure-rest-api-specs/pull/23541/checks?check_run_id=12710910388 which means your new api-version is not ready. Do you have any specific reason for that? |
Hi @MaryGao, this readiness check will get succeed once the ARM Manifest deployment will be rolled out. The new version is checked in.Only the ARM deployment is pending and it is not a blocker for this swagger PR to get completed. we will be deploying the ARM manifest once the Swagger PR is completed |
MaryGao
approved these changes
Apr 19, 2023
This was referenced Apr 19, 2023
Shashank1306s
added a commit
that referenced
this pull request
Apr 20, 2023
This reverts commit c655f50.
live1206
pushed a commit
that referenced
this pull request
Apr 20, 2023
suxi-ms
pushed a commit
that referenced
this pull request
Apr 24, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* Base commit from 2023-01-01 * Changing version from 2023-01-01 to 2023-05-01 * Adding Hooks changes in the new API version * Updating readme files of Microsoft.Dataprotection --------- Co-authored-by: SHASHANK SINGH <shashasingh@microsoft.com>
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…ure#23647) This reverts commit c655f50.
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.