Swagger Correctness BigDataPool #22303
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, @sparatala 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
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| bigDataPool.json | 2021-06-01-preview(1db49fc) | 2021-06-01-preview(main) |
| bigDataPool.json | 2021-06-01(1db49fc) | 2021-06-01(main) |
| Rule | Message |
|---|---|
|
The read only property has changed from 'false' to 'true'. New: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L433:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L433:9 |
|
The read only property has changed from 'false' to 'true'. New: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L433:9 Old: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L433:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2021-06 | package-2021-06(1db49fc) | package-2021-06(main) |
| package-preview-2021-06 | package-preview-2021-06(1db49fc) | package-preview-2021-06(main) |
| package-composite-v2 | package-composite-v2(1db49fc) | package-composite-v2(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
|
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
|
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
|
An async PUT operation must return 201. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L188 |
|
An async PUT operation must return 201. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L188 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L195 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L195 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L195 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L195 |
|
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L224 |
|
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L224 |
|
The delete response body must be empty. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L255 |
|
The delete response body must be empty. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L255 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L260 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L260 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L291 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L291 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L24 |
|
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L24 |
|
An async PUT operation must return 201. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L188 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L195 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L195 |
|
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L224 |
|
The delete response body must be empty. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L255 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L260 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L291 |
| The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L4 |
|
| The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L4 |
|
| The response of operation:'BigDataPools_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L25 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/synapse/resource-manager/readme.md tag: specification/synapse/resource-manager/readme.md#tag-package-composite-v2 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️~[Staging] CadlAPIView 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.
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @sparatala, 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. |
This was referenced Jan 25, 2023
Closed
bansalaseem
approved these changes
Jan 25, 2023
bansalaseem
added
the
ARMSignedOff
|
Hi @sparatala, Your PR has some issues. Please fix the CI sequentially by following the order of
|
JeffreyRichter
added
the
Approved-BreakingChange
tadelesh
added
the
Approved-SdkBreakingChange-Go
This was referenced Feb 2, 2023
Merged
Closed
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Feb 2, 2023
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.