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 preview/2020-06-01-preview #12622

Conversation

tengpanpt
Copy link
Contributor

@tengpanpt tengpanpt commented Jan 25, 2021

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @tengpanpt 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f862372. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cosmos-db/resource-manager/readme.md
    • ️✔️@azure/arm-cosmosdb [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/cosmosDBManagementClient.js → ./dist/arm-cosmosdb.js...
      cmderr	[npmPack] created ./dist/arm-cosmosdb.js in 682ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f862372. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️cosmos-db/mgmt/2019-08-01/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️cosmos-db/mgmt/2015-04-08/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/cosmos-db/mgmt/2020-06-01-preview/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Local`
      info	[Changelog] - New const `Geo`
      info	[Changelog] - New const `Zone`
      info	[Changelog] - New function `PossibleBackupStorageRedundancyValues() []BackupStorageRedundancy`
      info	[Changelog] - New field `BackupStorageRedundancy` in struct `PeriodicModeProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
      info	[Changelog]
    • ️✔️preview/cosmos-db/mgmt/2020-04-01-preview/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/cosmos-db/mgmt/2020-03-01-preview/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/cosmos-db/mgmt/2019-12-12-preview/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/cosmos-db/mgmt/2019-08-01-preview/documentdb [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f862372. 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] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
      cmderr	[automation_init.sh]   Failed building wheel for yarl
      cmderr	[automation_init.sh]   Failed building wheel for wrapt
      cmderr	[automation_init.sh]   Failed building wheel for multidict
      cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
      cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-cosmosdb [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model SqlContainerResource has a new parameter analytical_storage_ttl
      info	[Changelog]   - Model SqlContainerGetPropertiesResource has a new parameter analytical_storage_ttl
      info	[Changelog]   - Added operation SqlResourcesOperations.migrate_sql_database_to_autoscale
      info	[Changelog]   - Added operation SqlResourcesOperations.migrate_sql_container_to_manual_throughput
      info	[Changelog]   - Added operation SqlResourcesOperations.migrate_sql_container_to_autoscale
      info	[Changelog]   - Added operation SqlResourcesOperations.migrate_sql_database_to_manual_throughput
      info	[Changelog]   - Added operation CassandraResourcesOperations.migrate_cassandra_table_to_autoscale
      info	[Changelog]   - Added operation CassandraResourcesOperations.migrate_cassandra_keyspace_to_manual_throughput
      info	[Changelog]   - Added operation CassandraResourcesOperations.migrate_cassandra_keyspace_to_autoscale
      info	[Changelog]   - Added operation CassandraResourcesOperations.migrate_cassandra_table_to_manual_throughput
      info	[Changelog]   - Added operation TableResourcesOperations.migrate_table_to_autoscale
      info	[Changelog]   - Added operation TableResourcesOperations.migrate_table_to_manual_throughput
      info	[Changelog]   - Added operation GremlinResourcesOperations.migrate_gremlin_graph_to_manual_throughput
      info	[Changelog]   - Added operation GremlinResourcesOperations.migrate_gremlin_database_to_manual_throughput
      info	[Changelog]   - Added operation GremlinResourcesOperations.migrate_gremlin_database_to_autoscale
      info	[Changelog]   - Added operation GremlinResourcesOperations.migrate_gremlin_graph_to_autoscale
      info	[Changelog]   - Added operation MongoDBResourcesOperations.migrate_mongo_db_collection_to_manual_throughput
      info	[Changelog]   - Added operation MongoDBResourcesOperations.migrate_mongo_db_collection_to_autoscale
      info	[Changelog]   - Added operation MongoDBResourcesOperations.migrate_mongo_db_database_to_autoscale
      info	[Changelog]   - Added operation MongoDBResourcesOperations.migrate_mongo_db_database_to_manual_throughput
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model CassandraKeyspaceCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model DatabaseAccountGetResults no longer has parameter instance_id
      info	[Changelog]   - Model DatabaseAccountGetResults no longer has parameter system_data
      info	[Changelog]   - Model DatabaseAccountGetResults no longer has parameter restore_parameters
      info	[Changelog]   - Model DatabaseAccountGetResults no longer has parameter create_mode
      info	[Changelog]   - Model DatabaseAccountGetResults no longer has parameter identity
      info	[Changelog]   - Model SqlUserDefinedFunctionCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model SqlTriggerGetResults no longer has parameter identity
      info	[Changelog]   - Model TableCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model GremlinDatabaseGetResults no longer has parameter identity
      info	[Changelog]   - Model MongoDBCollectionCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model TableGetResults no longer has parameter identity
      info	[Changelog]   - Model ARMResourceProperties no longer has parameter identity
      info	[Changelog]   - Model SqlStoredProcedureGetResults no longer has parameter identity
      info	[Changelog]   - Model CassandraTableCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model MongoDBDatabaseCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model SqlDatabaseGetResults no longer has parameter identity
      info	[Changelog]   - Model CassandraTableGetResults no longer has parameter identity
      info	[Changelog]   - Model GremlinGraphCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model MongoDBCollectionGetResults no longer has parameter identity
      info	[Changelog]   - Model SqlUserDefinedFunctionGetResults no longer has parameter identity
      info	[Changelog]   - Model GremlinDatabaseCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model SqlContainerCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model SqlStoredProcedureCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model SqlDatabaseCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model ThroughputSettingsGetResults no longer has parameter identity
      info	[Changelog]   - Model ThroughputSettingsUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model CassandraKeyspaceGetResults no longer has parameter identity
      info	[Changelog]   - Model SqlContainerGetResults no longer has parameter identity
      info	[Changelog]   - Model MongoDBDatabaseGetResults no longer has parameter identity
      info	[Changelog]   - Model SqlTriggerCreateUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model DatabaseAccountUpdateParameters no longer has parameter identity
      info	[Changelog]   - Model GremlinGraphGetResults no longer has parameter identity
      info	[Changelog]   - Removed operation SqlResourcesOperations.delete_sql_role_definition
      info	[Changelog]   - Removed operation SqlResourcesOperations.create_update_sql_role_assignment
      info	[Changelog]   - Removed operation SqlResourcesOperations.create_update_sql_role_definition
      info	[Changelog]   - Removed operation SqlResourcesOperations.delete_sql_role_assignment
      info	[Changelog]   - Removed operation SqlResourcesOperations.get_sql_role_assignment
      info	[Changelog]   - Removed operation SqlResourcesOperations.list_sql_role_definitions
      info	[Changelog]   - Removed operation SqlResourcesOperations.get_sql_role_definition
      info	[Changelog]   - Removed operation SqlResourcesOperations.list_sql_role_assignments
      info	[Changelog]   - Model DatabaseAccountCreateUpdateParameters has a new signature
      info	[Changelog]   - Removed operation group RestorableSqlDatabasesOperations
      info	[Changelog]   - Removed operation group RestorableSqlContainersOperations
      info	[Changelog]   - Removed operation group RestorableMongodbCollectionsOperations
      info	[Changelog]   - Removed operation group RestorableMongodbDatabasesOperations
      info	[Changelog]   - Removed operation group RestorableDatabaseAccountsOperations
      info	[Changelog]   - Removed operation group RestorableMongodbResourcesOperations
      info	[Changelog]   - Removed operation group RestorableSqlResourcesOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f862372. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-02-02 02:04:56 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-cosmos-generated"
      cmderr	[generate.py] 2021-02-02 02:04:56 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-02-02 02:04:56 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/cosmos/azure-resourcemanager-cosmos-generated --java.namespace=com.azure.resourcemanager.cosmos.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/cosmos-db/resource-manager/readme.md
      cmderr	[generate.py] 2021-02-02 02:06:02 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-02-02 02:06:02 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-02-02 02:06:02 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-02-02 02:06:02 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-02-02 02:06:02 INFO [POM][Skip] pom already has module sdk/cosmos
      cmderr	[generate.py] 2021-02-02 02:06:02 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
      cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
      cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
      cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
      cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-cosmos-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-02-02 02:10:25 DEBUG Got artifact_id: azure-resourcemanager-cosmos-generated
      cmderr	[Inst] 2021-02-02 02:10:25 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-02-02 02:10:25 DEBUG Got artifact: azure-resourcemanager-cosmos-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-02-02 02:10:25 DEBUG Got artifact: azure-resourcemanager-cosmos-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-02 02:10:25 DEBUG Match jar package: azure-resourcemanager-cosmos-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-02 02:10:25 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12622/azure-sdk-for-java/azure-resourcemanager-cosmos-generated/azure-resourcemanager-cosmos-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-cosmos-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-cosmos-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-cosmos-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f862372. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/cosmos-db/resource-manager/readme.md
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/gremlin/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Using definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/gremlin/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Using definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/gremlin/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Using definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/gremlin/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Using definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Skipping definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/gremlin/databases/{databaseName}'.
      cmdout	[Autorest] WARNING: Found duplicate definition for variable-named type Microsoft.DocumentDB/databaseAccounts/apis/databases. Using definition with path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}'.
    • ️✔️cosmos-db [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @vinhms
    Copy link
    Contributor

    vinhms commented Jan 25, 2021

    Added some comments. Otherwise looks good.

    @tengpanpt tengpanpt added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jan 25, 2021
    @tengpanpt
    Copy link
    Contributor Author

    @erich-wang can you please review this PR and let my know if you have any concern. Thank you! (tepa)

    Copy link
    Contributor

    @MehaKaushik MehaKaushik left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Please re-design or remove the list backupStorageRedundancies api.

    @MehaKaushik MehaKaushik added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 28, 2021
    @pilor pilor added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 29, 2021
    @pilor pilor self-requested a review January 29, 2021 23:20
    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 29, 2021
    @tengpanpt tengpanpt removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jan 29, 2021
    @erich-wang
    Copy link
    Member

    @tengpanpt, adding optional property as considered as breaking change, you need to use new API version unless you're fixing swagger correctness.

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @tengpanpt tengpanpt closed this Feb 1, 2021
    @tengpanpt
    Copy link
    Contributor Author

    @tengpanpt, adding optional property as considered as breaking change, you need to use new API version unless you're fixing swagger correctness.

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    Hi @erich-wang , I am updating the preview version, which is only used for recent new backup and restore features. From "Breaking Change Review Checklist", it says "Updating API(s) in preview over 1 year". Do I still need new preview version? Thank you!

    @tengpanpt tengpanpt reopened this Feb 1, 2021
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 1, 2021
    @erich-wang erich-wang merged commit f862372 into Azure:master Feb 2, 2021
    This was referenced Feb 2, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …n preview/2020-06-01-preview (Azure#12622)
    
    * init
    
    * fix name
    
    * fix property
    
    * array format
    
    * fix lsit
    
    * fix response
    
    * name
    
    * discription
    
    * modify description
    
    * revert new api
    
    Co-authored-by: Teng Pan <tepa@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants