AAS - Fix Swagger Correctness v6#12999
Conversation
Merge Master
Merge Master
Merge latest master
Merge master
Merge Master
Merge Master
(cherry picked from commit 4556f27)
|
Hi, @david-msft 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. vsswagger@microsoft.com |
Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
|
| Rule | Message |
|---|---|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"The schema 'Operation-properties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"The schema 'Operation-properties-serviceSpecification' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"analysisservices/resource-manager/readme.md", "tag":"package-2017-08", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki Window to Fix Broken for more details. |
|
Hi @allenjzhang , |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
Hi @david-msft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
@zhenglaizhang what does mean SpellCheck? - My PR does not seem to have change to the Microsoft.Consumption Spec.. Are w good here to merge |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
May I know what is the blocker here? |
|
@david-msft spellcheck issues was resolved now |
| "readOnly": true | ||
| } | ||
| } | ||
| "$ref": "#/definitions/ErrorObject" |
There was a problem hiding this comment.
This ErrorObject does NOT conform to the ARM exception standard schema. Did you mean ErrorDetail. Adding ARM Reviewer.
There was a problem hiding this comment.
The ErrorDetail does not contain these three properties:
"subCode": {
"description": "The error sub code",
"type": "integer",
"format": "int32"
},
"httpStatusCode": {
"description": "The http status code",
"type": "integer",
"format": "int32"
},
"timeStamp": {
"description": "the timestamp for the error.",
"type": "string",
"readOnly": true
},
I mean yes since the two properties are pretty much the same. if we are good to add these three properties in ErrorDetail, we can fix it to use ErrorDetail.
There was a problem hiding this comment.
@allenjzhang is correct. The ARM error contract is documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Deviating from it is not allowed.
There was a problem hiding this comment.
@majastrz @allenjzhang hmm. I have all the required parameters in the ErrorObject. The properties in ErrorObject used be live in ErrorResponse but I took them out and made them as a property (schema) since they can be shared with other error responses.
May I please have your suggestion or recommendation to fix this? Can we include below properties
"subCode": {
"description": "The error sub code",
"type": "integer",
"format": "int32"
},
"httpStatusCode": {
"description": "The http status code",
"type": "integer",
"format": "int32"
},
"timeStamp": {
"description": "the timestamp for the error.",
"type": "string",
"readOnly": true
},
in ErrorDetail because they do show(catch) in the Swagger live validation.. ex: https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=523a5c5c-7749-417d-8ce1-6eab5433338e
There was a problem hiding this comment.
As ARM reviewer indicated, the ARM's response code is standardized. The subCode can be embedded in additionalInfo. HttpStatusCode is really necessary as it would be captured/reported on the client side. I don't know the scenario if the timeStamp is necessary or leveraged by the user. If you do want to include it as server's timeStamp, please include in the additinalInfo dictionary.
allenjzhang
added
the
WaitForARMFeedback
allenjzhang
left a comment
allenjzhang
left a comment
There was a problem hiding this comment.
@majastrz , @chiragg4u, can you review this non-standard ErrorObject schema?
|
Please go through the contribution checklist added as part of the review and mark them completed. This is a requirement before review can be continued. |
I will only review once the checklist is completed and the reasoning is understood. |
Since this is fixing the SDK runtime error I don't recommend to change the error object completely, as this will cause breaking changes in the existing API surface area. |
chiragg4u
added
ARMSignedOff
| "error": { | ||
| "description": "The error object", | ||
| "$ref": "#/definitions/ErrorObject" | ||
| "$ref": "#/definitions/ErrorDetail" |
There was a problem hiding this comment.
Recommend referring to common definitions "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/..." This will enforce the right schema.
|
@chiragg4u |
|
Hi @allenjzhang, |
5 participants
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.