-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
swagger changes for capacityMode changes #28457
swagger changes for capacityMode changes #28457
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.7) | new version | base version |
---|---|---|
cosmos-db.json | 2024-05-15-preview(ac31218) | 2023-11-15(main) |
cosmos-db.json | 2024-05-15-preview(ac31218) | 2024-02-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️
LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.0) | new version | base version |
---|---|---|
package-preview-2024-05 | package-preview-2024-05(ac31218) | package-preview-2024-05(release-cosmos-db-Microsoft.DocumentDB-2024-05-15-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GetCollectionResponseSchema |
The response in the GET collection operation 'CassandraClusters_ListCommand' does not match the response definition in the individual GET operation 'CassandraClusters_GetCommandAsync' . Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L36 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L69 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:defaultConsistencyLevel. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L95 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L95 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L110 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L157 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L201 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L317 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L350 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L386 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L435 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L445 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L494 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L504 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L535 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L568 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L641 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.DocumentDB/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L667 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L668 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. There is one exception for extension resources with fully qualified path and the author can go ahead and suppress the error(look at https://github.com/Azure/azure-openapi-validator/blob/main/docs/path-for-nested-resource.md#pathfornestedresource for more details) Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L938 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. There is one exception for extension resources with fully qualified path and the author can go ahead and suppress the error(look at https://github.com/Azure/azure-openapi-validator/blob/main/docs/path-for-nested-resource.md#pathfornestedresource for more details) Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L980 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1570 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1627 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1747 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1807 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1853 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1854 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1888 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2135 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2273 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Please check and fix the ModelValidation: https://github.com/Azure/azure-rest-api-specs/pull/28457/checks?check_run_id=23122348138 |
Please address or respond to feedback from the ARM API reviewer. |
/azp run |
Azure Pipelines successfully started running 4 pipeline(s). |
e5658f3
into
release-cosmos-db-Microsoft.DocumentDB-2024-05-15-preview
* swagger changes for capacityMode changes * Ran the npx Prettier command * fixing swagger lint * fixing camelcase issue
#29192) * Copy files from preview/2024-02-15-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-05-15-preview Updated the API version from preview/2024-02-15-preview to preview/2024-05-15-preview. * Added tag for 2024-05-15-preview in readme file * Add mongo v5 and v6 to the preview swagger (#28472) Co-authored-by: Andrew Khoma <[email protected]> * swagger changes for capacityMode changes (#28457) * swagger changes for capacityMode changes * Ran the npx Prettier command * fixing swagger lint * fixing camelcase issue * NSP RP changes for public preview (#28552) * NSP RP API changes * small change * validation failures handling * linter errors * types version * still failing * Probably all the fixes * Missed one file * Will revert this commit - temp fix for hanging push * Reverted commit --------- Co-authored-by: pjohari-ms <[email protected]> * Remove mongoCluster swagger spec and examples for 2024-05-15-preview release (#28693) * Porting from stable changes from Cassandra API (#28801) * nsp related comments (#28950) * Review comments - Cassandra and circular reference (#29021) * Review comments - Cassandra and circular reference * Nits - Services.json * Porting from stable brranch * Nits * Moved files * Using common types * Fixes * Used custom parameter - as suggested by reviewer * Merged commit correctly * Another merge remove issue * Prettier issues due to line endings being different during merge * Prettier check. Whole folder. --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: chandrasekhar gunturi <[email protected]> Co-authored-by: Vandit Jain <[email protected]> Co-authored-by: Oliver Towers <[email protected]>
Azure#29192) * Copy files from preview/2024-02-15-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-05-15-preview Updated the API version from preview/2024-02-15-preview to preview/2024-05-15-preview. * Added tag for 2024-05-15-preview in readme file * Add mongo v5 and v6 to the preview swagger (Azure#28472) Co-authored-by: Andrew Khoma <[email protected]> * swagger changes for capacityMode changes (Azure#28457) * swagger changes for capacityMode changes * Ran the npx Prettier command * fixing swagger lint * fixing camelcase issue * NSP RP changes for public preview (Azure#28552) * NSP RP API changes * small change * validation failures handling * linter errors * types version * still failing * Probably all the fixes * Missed one file * Will revert this commit - temp fix for hanging push * Reverted commit --------- Co-authored-by: pjohari-ms <[email protected]> * Remove mongoCluster swagger spec and examples for 2024-05-15-preview release (Azure#28693) * Porting from stable changes from Cassandra API (Azure#28801) * nsp related comments (Azure#28950) * Review comments - Cassandra and circular reference (Azure#29021) * Review comments - Cassandra and circular reference * Nits - Services.json * Porting from stable brranch * Nits * Moved files * Using common types * Fixes * Used custom parameter - as suggested by reviewer * Merged commit correctly * Another merge remove issue * Prettier issues due to line endings being different during merge * Prettier check. Whole folder. --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: chandrasekhar gunturi <[email protected]> Co-authored-by: Vandit Jain <[email protected]> Co-authored-by: Oliver Towers <[email protected]>
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PR
andDue diligence checklist
.Next Steps to Merge
comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.