Skip to content

Conversation

vinhms
Copy link
Contributor

@vinhms vinhms commented Mar 29, 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-workflow-bot
Copy link

Hi, @vinhms 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 29, 2023

    Swagger Validation Report

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

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

    Only 24 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-04-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-04-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-04-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-04-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 'CassandraViewCreateUpdateProperties' removed or renamed?
    New: Microsoft.DocumentDB/stable/2023-04-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: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-04 package-2023-04(4943fbf) default(main)

    The following errors/warnings exist before current PR submission:

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

    Only 24 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
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/gremlin/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
    ️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.DocumentDB' for api version '2023-04-15'. The supported api-versions are '2014-04-01,
    2015-04-08,
    2015-11-06,
    2016-03-19,
    2016-03-31,
    2019-08-01-preview,
    2019-08-01,
    2019-12-12,
    2020-03-01,
    2020-04-01,
    2020-06-01-preview,
    2020-09-01,
    2021-01-15,
    2021-03-01-preview,
    2021-03-15,
    2021-04-01-preview,
    2021-04-15,
    2021-05-01-preview,
    2021-05-15,
    2021-06-15,
    2021-07-01-preview,
    2021-10-15,
    2021-10-15-preview,
    2021-11-15-preview,
    2022-02-15-preview,
    2022-05-15-preview,
    2022-05-15,
    2022-08-15-preview,
    2022-08-15,
    2022-11-15,
    2022-11-15-preview,
    2023-03-01-preview'."
    ️⚠️~[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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 29, 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] Generate from 1ed16375547986c252f502316112c33bfe0382ec. 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.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2>
      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]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model ContinuousModeBackupPolicy has a new parameter continuous_mode_properties
      info	[Changelog]   - Model RestorableDatabaseAccountGetResult has a new parameter oldest_restorable_time
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1ed16375547986c252f502316112c33bfe0382ec. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.CosmosDB [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1ed16375547986c252f502316112c33bfe0382ec. 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]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `ContinuousTier` with values `ContinuousTierContinuous30Days`, `ContinuousTierContinuous7Days`
      info	[Changelog] - New function `NewClientFactory(string, azcore.TokenCredential, *arm.ClientOptions) (*ClientFactory, error)`
      info	[Changelog] - New function `*ClientFactory.NewCassandraClustersClient() *CassandraClustersClient`
      info	[Changelog] - New function `*ClientFactory.NewCassandraDataCentersClient() *CassandraDataCentersClient`
      info	[Changelog] - New function `*ClientFactory.NewCassandraResourcesClient() *CassandraResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewCollectionClient() *CollectionClient`
      info	[Changelog] - New function `*ClientFactory.NewCollectionPartitionClient() *CollectionPartitionClient`
      info	[Changelog] - New function `*ClientFactory.NewCollectionPartitionRegionClient() *CollectionPartitionRegionClient`
      info	[Changelog] - New function `*ClientFactory.NewCollectionRegionClient() *CollectionRegionClient`
      info	[Changelog] - New function `*ClientFactory.NewDatabaseAccountRegionClient() *DatabaseAccountRegionClient`
      info	[Changelog] - New function `*ClientFactory.NewDatabaseAccountsClient() *DatabaseAccountsClient`
      info	[Changelog] - New function `*ClientFactory.NewDatabaseClient() *DatabaseClient`
      info	[Changelog] - New function `*ClientFactory.NewGremlinResourcesClient() *GremlinResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewLocationsClient() *LocationsClient`
      info	[Changelog] - New function `*ClientFactory.NewMongoDBResourcesClient() *MongoDBResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewNotebookWorkspacesClient() *NotebookWorkspacesClient`
      info	[Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient`
      info	[Changelog] - New function `*ClientFactory.NewPartitionKeyRangeIDClient() *PartitionKeyRangeIDClient`
      info	[Changelog] - New function `*ClientFactory.NewPartitionKeyRangeIDRegionClient() *PartitionKeyRangeIDRegionClient`
      info	[Changelog] - New function `*ClientFactory.NewPercentileClient() *PercentileClient`
      info	[Changelog] - New function `*ClientFactory.NewPercentileSourceTargetClient() *PercentileSourceTargetClient`
      info	[Changelog] - New function `*ClientFactory.NewPercentileTargetClient() *PercentileTargetClient`
      info	[Changelog] - New function `*ClientFactory.NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient`
      info	[Changelog] - New function `*ClientFactory.NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableDatabaseAccountsClient() *RestorableDatabaseAccountsClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableGremlinDatabasesClient() *RestorableGremlinDatabasesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableGremlinGraphsClient() *RestorableGremlinGraphsClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableGremlinResourcesClient() *RestorableGremlinResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableMongodbCollectionsClient() *RestorableMongodbCollectionsClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableMongodbDatabasesClient() *RestorableMongodbDatabasesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableMongodbResourcesClient() *RestorableMongodbResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableSQLContainersClient() *RestorableSQLContainersClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableSQLDatabasesClient() *RestorableSQLDatabasesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableSQLResourcesClient() *RestorableSQLResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableTableResourcesClient() *RestorableTableResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewRestorableTablesClient() *RestorableTablesClient`
      info	[Changelog] - New function `*ClientFactory.NewSQLResourcesClient() *SQLResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewServiceClient() *ServiceClient`
      info	[Changelog] - New function `*ClientFactory.NewTableResourcesClient() *TableResourcesClient`
      info	[Changelog] - New struct `ClientFactory`
      info	[Changelog] - New struct `ContinuousModeProperties`
      info	[Changelog] - New field `ContinuousModeProperties` in struct `ContinuousModeBackupPolicy`
      info	[Changelog] - New field `OldestRestorableTime` in struct `RestorableDatabaseAccountProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 47 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1ed16375547986c252f502316112c33bfe0382ec. 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]  [Preview SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface ContinuousModeProperties
      info	[Changelog]   - Added Type Alias ContinuousTier
      info	[Changelog]   - Interface ContinuousModeBackupPolicy has a new optional parameter continuousModeProperties
      info	[Changelog]   - Interface RestorableDatabaseAccountGetResult has a new optional parameter oldestRestorableTime
      info	[Changelog]   - Added Enum KnownContinuousTier
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 1ed16375547986c252f502316112c33bfe0382ec. 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]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 1ed16375547986c252f502316112c33bfe0382ec. 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]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 29, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.DocumentDB https://apiview.dev/Assemblies/Review/66092aad84704d6382e7602100ffeb09
    Go sdk/resourcemanager/cosmos/armcosmos https://apiview.dev/Assemblies/Review/b6cb7d4e299e4dc89d2820126bb147db
    Java azure-resourcemanager-cosmos-generated Create ApiView failed. Please ask PR assignee for help
    .Net Azure.ResourceManager.CosmosDB There is no API change compared with the previous version
    JavaScript @azure/arm-cosmosdb https://apiview.dev/Assemblies/Review/fbef7b21d2cf4fb088ea0f28daa3713e

    @vinhms
    Copy link
    Contributor Author

    vinhms commented Apr 13, 2023

    Closing this draft PR

    The actual PR is #23532

    @vinhms vinhms closed this Apr 13, 2023
    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.

    2 participants