RecoveryServices Swagger PR for api-Version: 2024-04-01 #28597
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
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| registeredidentities.json | 2024-04-01(35ebfaa) | 2024-02-01(main) |
| registeredidentities.json | 2024-04-01(35ebfaa) | 2022-09-30-preview(main) |
| replicationusages.json | 2024-04-01(35ebfaa) | 2024-02-01(main) |
| replicationusages.json | 2024-04-01(35ebfaa) | 2022-09-30-preview(main) |
| vaults.json | 2024-04-01(35ebfaa) | 2024-02-01(main) |
| vaults.json | 2024-04-01(35ebfaa) | 2022-09-30-preview(main) |
| vaultusages.json | 2024-04-01(35ebfaa) | 2024-02-01(main) |
| vaultusages.json | 2024-04-01(35ebfaa) | 2022-09-30-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-04 | package-2024-04(35ebfaa) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Parameter should have a description. Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L456 |
||
| Parameter should have a description. Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L589 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName} is missing. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L20 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L20 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}' Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L21 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L21 |
|
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L21 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L21 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'VaultCertificates_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L22 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L22 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L64 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}' Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L80 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L80 |
|
The resource name parameter 'identityName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L80 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L80 |
|
Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L81 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L108 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L108 |
|
The nested resource 'VaultCertificateResponse' does not have list operation, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/registeredidentities.json#L300 |
|
The parameter 'SubscriptionId' 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.RecoveryServices/stable/2024-04-01/registeredidentities.json#L327 |
|
The parameter 'ApiVersion' 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.RecoveryServices/stable/2024-04-01/registeredidentities.json#L350 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages' Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L21 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L21 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L21 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L45 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L48 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L70 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L74 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L78 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L88 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L92 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L96 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Apr 5, 2024
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
WaitForARMFeedback
This was referenced Apr 5, 2024
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
rkmanda
reviewed
Apr 5, 2024
| "modelAsString": true | ||
| } | ||
| }, | ||
| "resourceGuardOperationRequests": { |
rkmanda
reviewed
Apr 5, 2024
| "resourceGuardOperationRequests": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" |
There was a problem hiding this comment.
This is of the format armid followed by a suffix
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
…/2024-02-01 to version 2024-04-01
hiaga
force-pushed
the
ankur741999-recoveryservices-Microsoft.RecoveryServices-2024-04-01
branch
from
2683bda to
35ebfaa
Compare
|
/pr RequestMerge |
AzureRestAPISpecReview
added
the
ReadyForApiTest
raosuhas
approved these changes
Apr 16, 2024
raosuhas
deleted the
ankur741999-recoveryservices-Microsoft.RecoveryServices-2024-04-01
branch
tjprescott
pushed a commit
that referenced
this pull request
Apr 17, 2024
* Adds base for updating Microsoft.RecoveryServices from version stable/2024-02-01 to version 2024-04-01 * Updates readme * Updates API version in new specs and examples * Added MUA changes * Added optional headers for critical operations * Create sdk-suppressions.yaml * Added Description and fixed the params ordering * Fixed typo * azure-sdk-for-go suppression * Update sdk-suppressions.yaml * edit suppression file * added example reference --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: v-tianxi <v-tianxi@microsoft.com> Co-authored-by: Himanshu Agarwal <hiaga@microsoft.com>
wiboris
pushed a commit
to wiboris/azure-rest-api-specs
that referenced
this pull request
May 7, 2024
* Adds base for updating Microsoft.RecoveryServices from version stable/2024-02-01 to version 2024-04-01 * Updates readme * Updates API version in new specs and examples * Added MUA changes * Added optional headers for critical operations * Create sdk-suppressions.yaml * Added Description and fixed the params ordering * Fixed typo * azure-sdk-for-go suppression * Update sdk-suppressions.yaml * edit suppression file * added example reference --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: v-tianxi <v-tianxi@microsoft.com> Co-authored-by: Himanshu Agarwal <hiaga@microsoft.com>
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 (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.