Add xms-ids for RecoveryServices #17997
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, @LinglingTong 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. [email protected] |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages' Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L21 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages' Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaultusages.json#L21 |
|
The response of operation:'VaultExtendedInfo_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L548 |
|
The response of operation:'VaultExtendedInfo_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L592 |
|
The response of operation:'VaultExtendedInfo_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L648 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L45 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaultusages.json#L45 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L456 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L70 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L74 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L78 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L88 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L92 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L96 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L100 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L104 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L108 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L126 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L130 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L134 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/replicationusages.json#L138 |
|
The response schema of operations API '/providers/Microsoft.RecoveryServices/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L231 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName} is missing. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaultusages.json#L20 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaultusages.json#L20 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L1706 |
|
The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L1716 |
|
The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L1756 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L943 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L1143 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json#L1216 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
This was referenced Feb 24, 2022
|
Hi @amchandn, I see you have contributed to RecoveryServices earlier. If you are on the RP team, could you please help me with a code review? Thanks! |
|
Hi, @LinglingTong. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
|
@changlong-liu there are only a few lines of change in this PR and all the xms-ids look intuitive. I wonder if you could help with a code review and merging the PR. Thanks! |
|
Hi @ArcturusZhang , would you help review the reported GoLang breaking change? |
Hi @LinglingTong , sorry for the delayed response. Can you please tell why this change is needed? Adding @asmaskar and [email protected] as they're from the RP team. |
Thanks for Looking at it @amchandn. The x-ms-identifiers is a new annotation introduced end of last year, and is currently used by change analysis team to identify the unique identifiers of an object type array. See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers. Our team is currently initializing this annotation for all the RPs and would like the owner team to help us with reviewing the change. You can also make changes after this PR is checked in and it shouldn't be a breaking change. |
|
@LinglingTong , asmaskar from RP team has approved the changes. Can we merge this PR now? |
Yes please. Thanks! |
|
@changlong-liu , can you please merge this PR? |
This was referenced Mar 25, 2022
This was referenced Mar 25, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Mar 25, 2022
visingl
pushed a commit
that referenced
this pull request
Mar 30, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
About this Change
APIs will need to start indicating item uniqueness in arrays. By default, uniqueness is the string property called "id" of items in an array. When that property does not exist, the x-ms-identifiers extension property must be used to specify the identifying property(s) or lack thereof. This pull request is my best guess effort to ease resource providers into the new requirement before it becomes enforced. Compliance and accuracy will need to be owned and maintained by the resource provider going forward.
See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers.
You can also make changes after this PR is checked in. At this point, this annotation is only used by Change Analysis for change computation, so making changes afterwards shouldn’t be a breaking change.
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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.