-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
Add x-ms-identifiers to reservations\resource-manager. #17761
Conversation
Hi, @vukelich 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] |
Swagger Validation Report
|
Rule | Message |
---|---|
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L934 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L988 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L1440 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L1452 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L1463 |
R3007 - PutGetPatchResponseSchema |
/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimits/{resourceName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L37 |
R3007 - PutGetPatchResponseSchema |
/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimits/{resourceName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L37 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L415 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L415 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L419 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L419 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L522 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L522 |
R4037 - MissingTypeObject |
The schema 'ResourceName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L449 |
R4037 - MissingTypeObject |
The schema 'ResourceName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L449 |
R4037 - MissingTypeObject |
The schema 'QuotaLimits' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L464 |
R4037 - MissingTypeObject |
The schema 'QuotaLimits' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L464 |
R4037 - MissingTypeObject |
The schema 'QuotaLimitsResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L483 |
R4037 - MissingTypeObject |
The schema 'QuotaLimitsResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L483 |
R4039 - ParametersOrder |
The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L466 |
R4039 - ParametersOrder |
The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L555 |
Since operation 'ReservationOrder_ChangeDirectory' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L831 |
|
'PUT' operation 'ReservationOrder_Purchase' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L234 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L405 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L405 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L443 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L443 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L598 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2020-10-25/quota.json#L598 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2021-07-01/reservations.json#L1022 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/reservations/resource-manager/readme.md tag: specification/reservations/resource-manager/readme.md#tag-package-2021-07-01 |
️️✔️
~[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: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Code style issues found path: Microsoft.Capacity/stable/2021-07-01/reservations.json |
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
[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. |
Hi, @vukelich. 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 |
Hi, @vukelich. 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 |
Hi, @vukelich. 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 |
Hi, @vukelich. 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 |
Hi, @vukelich. 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 |
Hi, @vukelich. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
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:
EXPLANATION OF THIS CHANGE
APIs will need to start indicating item uniqueness in
array
s. By default, uniqueness is thestring
property called"id"
of items in anarray
. When that property does not exist, thex-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.
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.