-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Next link modifications #28955
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
Next link modifications #28955
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
Compared specs (v0.10.8) | new version | base version |
---|---|---|
cosmos-db.json | 2024-05-15-preview(b2f9454) | 2023-11-15(main) |
cosmos-db.json | 2024-05-15-preview(b2f9454) | 2024-02-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️❌
LintDiff: 4 Errors, 0 Warnings failed [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-preview-2024-05 | package-preview-2024-05(b2f9454) | package-preview-2024-05(release-cosmos-db-Microsoft.DocumentDB-2024-05-15-preview) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
NextLinkPropertyMustExist |
The property 'nextLink' specified by nextLinkName does not exist in the 200 response schema. Please, specify the name of the property that provides the nextLink. If the model does not have the nextLink property then specify null. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L254 |
RPC-Get-V1-06 |
XmsPageableMustHaveCorrespondingResponse |
The operation: 'DatabaseAccounts_List' is defined with x-ms-pageable enabled,but can not find the corresponding nextLink property in the response, please add it. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L254 |
|
NextLinkPropertyMustExist |
The property 'nextLink' specified by nextLinkName does not exist in the 200 response schema. Please, specify the name of the property that provides the nextLink. If the model does not have the nextLink property then specify null. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L284 |
RPC-Get-V1-06 |
XmsPageableMustHaveCorrespondingResponse |
The operation: 'DatabaseAccounts_ListByResourceGroup' is defined with x-ms-pageable enabled,but can not find the corresponding nextLink property in the response, please add it. Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L284 |
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
|
…ew' into nextlink_databaseaccounts
Please fill out the Purpose of this PR and Due diligence checklist |
Fix the Swagger LintDiff errors about missing nextLink property |
Hi, @pjohari-ms. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @pjohari-ms. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
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.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
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.