Skip to content
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

[Microsoft.DocumentDB] CosmosDB - New API Version - 2024-05-15-preview #29192

Merged
merged 19 commits into from
May 22, 2024

Merge branch 'pjohari-ms-cdb-240515p' of https://github.com/Azure/azu…

53589e1
Select commit
Loading
Failed to load commit list.
Merged

[Microsoft.DocumentDB] CosmosDB - New API Version - 2024-05-15-preview #29192

Merge branch 'pjohari-ms-cdb-240515p' of https://github.com/Azure/azu…
53589e1
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff completed May 22, 2024 in 3m 24s

Swagger LintDiff failed

LintDiff: 300 Errors, 790 Warnings
The check status is neutral due to the check being suppressed by the label Approved-LintDiff.
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.2) new version base version
package-preview-2024-05 package-preview-2024-05(53589e1) default(main)

[must fix]The following errors/warnings are introduced by current PR:
Only 50 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
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
RPC-Get-V1-10
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
RPC-Async-V1-11, RPC-Put-V1-11
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
RPC-Delete-V1-01
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#L6925
RPC-Async-V1-11, RPC-Put-V1-11
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#L6985
RPC-Delete-V1-01
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#L7037
RPC-Put-V1-02
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L7038
RPC-Get-V1-13
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#L7075
RPC-Async-V1-11, RPC-Put-V1-11
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/dataTransferService.json#L38
RPC-Async-V1-11, RPC-Put-V1-11
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/managedCassandra.json#L400
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/managedCassandra.json#L406
RPC-Get-V1-10
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/privateEndpointConnection.json#L36
RPC-Get-V1-10
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1510
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1513
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1519
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1546
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1549
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1558
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1581
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1584
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1593
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1638
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1641
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1650
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: CosmosDBSqlDatabaseList
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1679
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: CosmosDBSqlDatabaseGet
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1715
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: CosmosDBSqlDatabaseDelete
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L1809
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2403
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2406
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2415
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2471
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2474
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2486
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2759
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2762
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2771
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2827
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2830
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2839
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2895
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2898
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2910
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2966
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2969
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2981
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L4025
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L4028
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L4037
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L4093
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L4096


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
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#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
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#L2339
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#L2527
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L2528
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#L2565
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#L3111
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#L3174
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#L3309
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#L3372
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#L3507
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#L3570
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#L3693
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#L3753
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#L3799
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L3800
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#L3834
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#L4365
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#L4428
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#L4616
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L4617
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#L4654
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#L4904
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#L4961
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#L5007