-
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
[Hub Generated] Review request for Microsoft.Support to add version preview/2021-06-01-preview #14586
[Hub Generated] Review request for Microsoft.Support to add version preview/2021-06-01-preview #14586
Conversation
…01 to version 2021-06-01-preview
…ew/2021-06-01-preview/examples directory
Hi, @mudit794 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 |
[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 |
---|---|
OperationId should contain the verb: 'lookupresourceid' in:'LookUpResourceId_Post'. Consider updating the operationId Location: Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json#L79 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Support/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json#L37 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"support/resource-manager/readme.md",
"tag":"package-preview-2021-06",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"support/resource-manager/readme.md",
"tag":"package-preview-2021-06",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"support/resource-manager/readme.md",
"tag":"package-preview-2021-06",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
@ArcturusZhang Do we need to have all resource types and paths in new api version even though they have no change? This is regarding Cross-Version Breaking changes failure. |
@mudit794 if you are adding new features (operations) in a new api-version and do not want to copy those operations defined in an older api-version, please use a different swagger filename. Otherwise you will have to first copy the swagger file in old api-version with the same name, then add your new operations. |
"details": { | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/definitions/ServiceErrorDetail" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ARM error definition is completely recursive, so this could be a reference to ServiceError
. In general, you should avoid declaring your own definitions for common contracts and reference them out of common types v2 area of the repo. (This comment doesn't block the PR, though.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed error code from manifest and example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The API looks good overall, but you need to fix the status codes. I put a comment explaining what to do there.
@majastrz Fixed the status code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signed off from ARM side.
@ArcturusZhang can you please review PR and merge it? I am not sure why go sdk started failing. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
…review/2021-06-01-preview (Azure#14586) * Adds base for updating Microsoft.Support from version stable/2020-04-01 to version 2021-06-01-preview * Updates readme * Updates API version in new specs and examples * Add GetSupportTicketResourceId * Delete CheckNameAvailabilityForSupportTicketCommunication.json * Delete specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples directory * add example * list operations * Update LookUpSupportTicketResourceId.json * Update readme.md * Update support.json * Update support.json * Rename support.json to supportLookUpResourceId.json * Rename supportLookUpResourceId.json to supportTicketsResourceIdDetails.json * Update readme.md * Update ListOperations.json * Update LookUpSupportTicketResourceId.json * make swagger generic for resource id look up * Update LookUpSupportTicketResourceId.json * Update LookUpSupportTicketResourceId.json * Rename LookUpSupportTicketResourceId.json to LookUpResourceId.json * Update readme.md * Update LookUpResourceId.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * remove error code * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json
…review/2021-06-01-preview (Azure#14586) * Adds base for updating Microsoft.Support from version stable/2020-04-01 to version 2021-06-01-preview * Updates readme * Updates API version in new specs and examples * Add GetSupportTicketResourceId * Delete CheckNameAvailabilityForSupportTicketCommunication.json * Delete specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples directory * add example * list operations * Update LookUpSupportTicketResourceId.json * Update readme.md * Update support.json * Update support.json * Rename support.json to supportLookUpResourceId.json * Rename supportLookUpResourceId.json to supportTicketsResourceIdDetails.json * Update readme.md * Update ListOperations.json * Update LookUpSupportTicketResourceId.json * make swagger generic for resource id look up * Update LookUpSupportTicketResourceId.json * Update LookUpSupportTicketResourceId.json * Rename LookUpSupportTicketResourceId.json to LookUpResourceId.json * Update readme.md * Update LookUpResourceId.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json * remove error code * Update supportResourceIdDetails.json * Update LookUpResourceId.json * Update supportResourceIdDetails.json
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Latest improvements:
### Contribution checklist: - [ ] I have reviewed the [documentation](https://github.com/Azure/azure-rest-api-specs#basics) for the workflow. - [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR. - [ ] The [OpenAPI Hub](https://aka.ms/openapiportal) was used for checking validation status and next steps. ### ARM API Review Checklist - [ ] Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories. - adding/removing APIs. - adding/removing properties. - adding/removing API-version. - adding a new service in Azure.
Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.
Please follow the link to find more details on API review process.