[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2023-03-15-preview #23327
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
…-03-01-preview to version 2023-03-15-preview
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| cosmos-db.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| cosmos-db.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| dataTransferService.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| managedCassandra.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| managedCassandra.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| mongoCluster.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| mongorbac.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| mongorbac.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| notebook.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| notebook.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| privateEndpointConnection.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| privateEndpointConnection.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| privateLinkResources.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| privateLinkResources.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| rbac.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| rbac.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| restorable.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| restorable.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
| services.json | 2023-03-15-preview(bc21c3f) | 2023-03-15(main) |
| services.json | 2023-03-15-preview(bc21c3f) | 2023-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 70 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-preview-2023-03-15 | package-preview-2023-03-15(bc21c3f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
LRO PATCH must have 200 and 202 return codes. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L69 |
|
A LRO POST operation must have both 200 & 202 return codes. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L201 |
|
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L386 |
|
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L445 |
|
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L568 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L641 |
|
The response schema of operations API '/providers/Microsoft.DocumentDB/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L667 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L668 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L938 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L980 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10860 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L174 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L183 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L236 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L263 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L263 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L263 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L274 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L289 |
|
A LRO POST operation must have both 200 & 202 return codes. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L296 |
|
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L296 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L329 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L338 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L538 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L547 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L603 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L633 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L633 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L644 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L659 |
️❌Avocado: 2 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/repair is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/fetchNodeStatus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json |
| The JSON file has a circular reference. readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2023-03-15-preview/privateEndpointConnection.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Hi, @SrinikhilReddy 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. vscswagger@microsoft.com |
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
This was referenced Mar 28, 2023
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @SrinikhilReddy, 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. |
vivek-microsoft
force-pushed
the
SrinikhilReddy-cosmos-db-Microsoft.DocumentDB-2023-03-15-preview-new
branch
from
8ba993c to
c752e59
Compare
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
adds database partition merge api.
pilor
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
pilor
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
The avacodo checker is failing on a very old version (2017) can we get an exception for this? |
|
Hi @SrinikhilReddy, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
|
Duplicate schema problem need to be addressed: ErrorResponse, ProvisioningState, Resource and ProxyResource. You need to check if you use different version of common model or define two different models with same name. |
|
Discussed with service team offline that all these issue will be addressed in next version. |
tadelesh
approved these changes
May 20, 2023
tadelesh
deleted the
SrinikhilReddy-cosmos-db-Microsoft.DocumentDB-2023-03-15-preview-new
branch
This was referenced May 20, 2023
qiaozha
reviewed
Jul 13, 2023
| @@ -27,9 +27,27 @@ These are the global settings for the Cosmos-DB API. | |||
| ``` yaml | |||
| title: CosmosDBManagementClient | |||
| openapi-type: arm | |||
| tag: package-2023-04 | |||
| tag: package-preview-2023-03-15 | |||
There was a problem hiding this comment.
why this is allowed ? we should never change a default tag to use an older preview version replace the newer version stable.
There was a problem hiding this comment.
@JeffreyRichter @mikekistler I don't think for this case, we have properly reviewed the cross version breaking change yet, because they are adding an older preview version, and breaking change detection tool will only compare with version prior to this current one.
But they already has version 2023-04-15 merged in April #23532
which is the bind zone of the breaking change detection tool. I think
There was a problem hiding this comment.
oops, it seems we have released this version for all languages.
There was a problem hiding this comment.
I'm not sure if you're asking Mike or I to do something here or not?
If you are, then I think we need more of an explanation as to what happened and what you want us to do.
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.