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

[Hub Generated] Review request for Microsoft.DocumentDB to add version stable/2023-03-15 #22937

Merged

Conversation

ghost
Copy link

@ghost ghost commented Mar 6, 2023

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 6, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 207 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
cosmos-db.json 2023-03-15(9782d02) 2022-11-15(main)
cosmos-db.json 2023-03-15(9782d02) 2023-03-01-preview(main)
managedCassandra.json 2023-03-15(9782d02) 2022-11-15(main)
managedCassandra.json 2023-03-15(9782d02) 2023-03-01-preview(main)
mongorbac.json 2023-03-15(9782d02) 2022-11-15(main)
mongorbac.json 2023-03-15(9782d02) 2023-03-01-preview(main)
notebook.json 2023-03-15(9782d02) 2022-11-15(main)
notebook.json 2023-03-15(9782d02) 2023-03-01-preview(main)
privateEndpointConnection.json 2023-03-15(9782d02) 2022-11-15(main)
privateEndpointConnection.json 2023-03-15(9782d02) 2023-03-01-preview(main)
privateLinkResources.json 2023-03-15(9782d02) 2022-11-15(main)
privateLinkResources.json 2023-03-15(9782d02) 2023-03-01-preview(main)
rbac.json 2023-03-15(9782d02) 2022-11-15(main)
rbac.json 2023-03-15(9782d02) 2023-03-01-preview(main)
restorable.json 2023-03-15(9782d02) 2022-11-15(main)
restorable.json 2023-03-15(9782d02) 2023-03-01-preview(main)
services.json 2023-03-15(9782d02) 2022-11-15(main)
services.json 2023-03-15(9782d02) 2023-03-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Only 23 items are listed, please refer to log for more details.

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L1499:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L1535:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/partitionMerge' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L2385:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L2673:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/redistributeThroughput' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L2741:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L2809:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/redistributeThroughput' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L2880:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L3939:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/redistributeThroughput' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L4007:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L4075:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L4146:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/partitionMerge' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L4406:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L6709:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L6748:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L6898:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToAutoscale' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L6997:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToManualThroughput' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L7056:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/managedCassandra.json#L344:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId}' removed or restructured?
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/managedCassandra.json#L386:5
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'GraphResourceCreateUpdateParameters' removed or renamed?
New: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L5823:3
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L7116:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'GraphResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L5823:3
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L7116:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'GraphResource' removed or renamed?
New: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L5823:3
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L7116:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CassandraViewCreateUpdateParameters' removed or renamed?
New: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L5823:3
Old: Microsoft.DocumentDB/preview/2023-03-01-preview/cosmos-db.json#L7116:3
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-2023-03 package-2023-03(9782d02) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L9821
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L9826
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.DocumentDB/stable/2023-03-15/managedCassandra.json#L1169
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.DocumentDB/stable/2023-03-15/managedCassandra.json#L1342


The following errors/warnings exist before current PR submission:

Only 23 items are listed, please refer to log for more details.

Rule Message
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/stable/2023-03-15/cosmos-db.json#L435
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/stable/2023-03-15/cosmos-db.json#L494
OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.DocumentDB/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L667
PathForNestedResource The path for nested resource doest not meet the valid resource pattern.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L938
PathForNestedResource The path for nested resource doest not meet the valid resource pattern.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L980
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1535
AllResourcesMustHaveDelete The resource ThroughputSettingsGetResults does not have a corresponding delete operation.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1673
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1673
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1766
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1822
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1878
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1917
ResourceNameRestriction The resource name parameter 'containerName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L1917
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2064
ResourceNameRestriction The resource name parameter 'containerName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2064
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2163
ResourceNameRestriction The resource name parameter 'containerName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2163
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2222
ResourceNameRestriction The resource name parameter 'containerName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2222
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2281
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2320
ResourceNameRestriction The resource name parameter 'clientEncryptionKeyName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2320
ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
Location: Microsoft.DocumentDB/stable/2023-03-15/cosmos-db.json#L2419
️❌Avocado: 27 Errors, 1 Warnings failed [Detail]

Only 23 items are listed, please refer to log for more details.

Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/containers 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/containers/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/containers/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases/{}/collections 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases/{}/collections/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases/{}/collections/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/table/tables 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/table/tables/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/table/tables/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/cassandra/keyspaces 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/cassandra/keyspaces/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/cassandra/keyspaces/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/cassandra/keyspaces/{}/tables 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/cassandra/keyspaces/{}/tables/{} 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/cassandra/keyspaces/{}/tables/{}/settings/throughput 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/gremlin/databases 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/stable/2016-03-31/cosmos-db.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/gremlin/databases/{} 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/stable/2016-03-31/cosmos-db.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 succeeded [Detail] [Expand]
️️✔️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.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @carjackson-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 6, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking




    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a1d4011. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.4
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.4>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-cosmosdb [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model CassandraClusterDataCenterNodeItem has a new parameter cassandra_process_status
      info	[Changelog]   - Model CassandraClusterPublicStatus has a new parameter errors
      info	[Changelog]   - Model ClusterResourceProperties has a new parameter provision_error
      info	[Changelog]   - Model DataCenterResourceProperties has a new parameter authentication_method_ldap_properties
      info	[Changelog]   - Model DataCenterResourceProperties has a new parameter deallocated
      info	[Changelog]   - Model DataCenterResourceProperties has a new parameter provision_error
      info	[Changelog]   - Model DatabaseAccountConnectionString has a new parameter key_kind
      info	[Changelog]   - Model DatabaseAccountConnectionString has a new parameter type
      info	[Changelog]   - Model LocationProperties has a new parameter is_subscription_region_access_allowed_for_az
      info	[Changelog]   - Model LocationProperties has a new parameter is_subscription_region_access_allowed_for_regular
      info	[Changelog]   - Model LocationProperties has a new parameter status
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a1d4011. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/cosmos/armcosmos [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `AuthenticationMethodLdap` added to enum type `AuthenticationMethod`
      info	[Changelog] - New enum type `Kind` with values `KindPrimary`, `KindPrimaryReadonly`, `KindSecondary`, `KindSecondaryReadonly`
      info	[Changelog] - New enum type `Status` with values `StatusDeleting`, `StatusInitializing`, `StatusInternallyReady`, `StatusOnline`, `StatusUninitialized`
      info	[Changelog] - New enum type `Type` with values `TypeCassandra`, `TypeCassandraConnectorMetadata`, `TypeGremlin`, `TypeGremlinV2`, `TypeMongoDB`, `TypeSQL`, `TypeSQLDedicatedGateway`, `TypeTable`, `TypeUndefined`
      info	[Changelog] - New struct `AuthenticationMethodLdapProperties`
      info	[Changelog] - New struct `CassandraError`
      info	[Changelog] - New field `Errors` in struct `CassandraClusterPublicStatus`
      info	[Changelog] - New field `ProvisionError` in struct `ClusterResourceProperties`
      info	[Changelog] - New field `CassandraProcessStatus` in struct `ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems`
      info	[Changelog] - New field `AuthenticationMethodLdapProperties` in struct `DataCenterResourceProperties`
      info	[Changelog] - New field `Deallocated` in struct `DataCenterResourceProperties`
      info	[Changelog] - New field `ProvisionError` in struct `DataCenterResourceProperties`
      info	[Changelog] - New field `KeyKind` in struct `DatabaseAccountConnectionString`
      info	[Changelog] - New field `Type` in struct `DatabaseAccountConnectionString`
      info	[Changelog] - New field `IsSubscriptionRegionAccessAllowedForAz` in struct `LocationProperties`
      info	[Changelog] - New field `IsSubscriptionRegionAccessAllowedForRegular` in struct `LocationProperties`
      info	[Changelog] - New field `Status` in struct `LocationProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 32 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a1d4011. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-cosmosdb [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface AuthenticationMethodLdapProperties
      info	[Changelog]   - Added Interface CassandraError
      info	[Changelog]   - Added Type Alias Kind
      info	[Changelog]   - Added Type Alias Status
      info	[Changelog]   - Added Type Alias Type
      info	[Changelog]   - Interface CassandraClusterPublicStatus has a new optional parameter errors
      info	[Changelog]   - Interface ClusterResourceProperties has a new optional parameter provisionError
      info	[Changelog]   - Interface ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems has a new optional parameter cassandraProcessStatus
      info	[Changelog]   - Interface DatabaseAccountConnectionString has a new optional parameter keyKind
      info	[Changelog]   - Interface DatabaseAccountConnectionString has a new optional parameter type
      info	[Changelog]   - Interface DataCenterResourceProperties has a new optional parameter authenticationMethodLdapProperties
      info	[Changelog]   - Interface DataCenterResourceProperties has a new optional parameter deallocated
      info	[Changelog]   - Interface DataCenterResourceProperties has a new optional parameter provisionError
      info	[Changelog]   - Interface LocationProperties has a new optional parameter isSubscriptionRegionAccessAllowedForAz
      info	[Changelog]   - Interface LocationProperties has a new optional parameter isSubscriptionRegionAccessAllowedForRegular
      info	[Changelog]   - Interface LocationProperties has a new optional parameter status
      info	[Changelog]   - Added Enum KnownKind
      info	[Changelog]   - Added Enum KnownStatus
      info	[Changelog]   - Added Enum KnownType
      info	[Changelog]   - Enum KnownAuthenticationMethod has a new value Ldap
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a1d4011. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️cosmos-db [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from a1d4011. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • Az.cosmos-db.DefaultTag [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 6, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/cosmos/armcosmos https://apiview.dev/Assemblies/Review/464974c49c274809b8e97789fdb344bf
    Java azure-resourcemanager-cosmos-generated https://apiview.dev/Assemblies/Review/f480cac6e3f64fef87d2cc6ec21b2809
    .Net Azure.ResourceManager.CosmosDB https://apiview.dev/Assemblies/Review/981047548fc4480f940a65f40b18be3d
    JavaScript @azure/arm-cosmosdb https://apiview.dev/Assemblies/Review/1804f47b27e746858ddf42e95a8b885c

    @ghost ghost added the Cosmos label Mar 6, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 16, 2023
    @openapi-workflow-bot
    Copy link

    Hi @carjackson-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @pjohari-ms
    Copy link
    Member

    @lirenhe We got an arm signoff. The Avocado test that's failing is due to APIs present in a much older version (2016) and we would like to get an exception for this.
    Additionally, what are the ways we can fix this avocado exception going forward, considering that we don't have these APIs anymore. Should we update the older API version as a last resort?

    @ghost
    Copy link
    Author

    ghost commented Apr 3, 2023

    @lirenhe We got an arm signoff. The Avocado test that's failing is due to APIs present in a much older version (2016) and we would like to get an exception for this. Additionally, what are the ways we can fix this avocado exception going forward, considering that we don't have these APIs anymore. Should we update the older API version as a last resort?

    Hi @lirenhe, just following up on this comment from @pjohari-ms. Is it possible to get an exception for the Avocado check?

    @lirenhe
    Copy link
    Member

    lirenhe commented Apr 6, 2023

    I added the label to suppress the avocado check as it reports the error for an old API version.

    @qiaozha, could you take a look at the JS SDK breaking change? Thanks

    @pjohari-ms
    Copy link
    Member

    @lirenhe Can you please merge the PR?

    @lirenhe
    Copy link
    Member

    lirenhe commented Apr 10, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @pjohari-ms
    Copy link
    Member

    @lirenhe Please merge the PR. Thanks.

    @lirenhe lirenhe merged commit a1d4011 into main Apr 11, 2023
    @lirenhe lirenhe deleted the carjackson-msft-cosmos-db-Microsoft.DocumentDB-2023-03-15 branch April 11, 2023 04:52
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    …n stable/2023-03-15 (Azure#22937)
    
    * Adds base for updating Microsoft.DocumentDB from version stable/2022-11-15 to version 2023-03-15
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * update listconnectionstrings response
    
    * update enum name
    
    * update enum and description
    
    * Add location api updates
    
    * fix cdb resource-manager spec readme after merge
    
    * Added buildout custom word for spell checker
    
    * remove extra space from readme
    
    * update listconnectionstrings response example to be more specific
    
    * Add enum for location status
    
    * stable swagger for nova.
    
    * Add provision cluser error, LDAP connection timeout.
    
    * fix bug in json.
    
    * fix apiversion and case.
    
    * fix validation errors.
    
    * pretty check.
    
    * add cassandraProcessStatus property.
    
    ---------
    
    Co-authored-by: Udit Singh <[email protected]>
    Co-authored-by: Vivek Sundararajan <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    9 participants