[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2022-05-15-preview #19721

ekuhlmann23 · 2022-07-08T13:09:20Z

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:

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
  This is a correction, adding the changes included in the 2022-05-15 stable to the preview version. These changes were incorrectly left out of the preview version.
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
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):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 · 2022-07-08T13:09:22Z

Hi, @ekuhlmann23 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 · 2022-07-08T13:09:25Z

Swagger Validation Report

️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.9.6)]	new version	base version
2022-05-15-preview	2022-05-15(d142ff6)	2022-05-15(main)

Rule	Message
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'id' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/restorable.json#L1265:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L10283:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'name' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/restorable.json#L1265:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L10283:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'type' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/restorable.json#L1265:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L10283:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'id' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/restorable.json#L1469:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L10283:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'name' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/restorable.json#L1469:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L10283:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'type' in response that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/restorable.json#L1469:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L10283:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'analyticalStorageTtl' that was not found in the old version. New: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L9444:7 Old: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L9444:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-preview-2022-05	package-preview-2022-05(d142ff6)	package-preview-2022-05(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` R2026 - AvoidAnonymousTypes	Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L9577
`❌` R4007 - DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L405
`❌` R4007 - DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L454
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8443
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8467
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2022-05-15-preview/cosmos-db.json#L8475

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck 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.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/d142ff69b9612d9581ecaa654b1d42b5ca133292/specification/cosmos-db/resource-manager/readme.md#tag-package-preview-2022-05">cosmos-db/resource-manager/readme.md#package-preview-2022-05

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ PreCheck/PropertyRedeclarationWarning	"readme":"cosmos-db/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Schema 'DatabaseAccountGetResults' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountGetResults"
⚠️ PreCheck/PropertyRedeclarationWarning	"readme":"cosmos-db/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Schema 'DatabaseAccountCreateUpdateParameters' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountCreateUpdateParameters"
⚠️ UnkownSecurityScheme	"readme":"cosmos-db/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️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.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-07-08T13:09:26Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - armcosmos - Approved - 1.1.0-beta.2

+	Type of `RestorableMongodbResourcesListResult.Value` has been changed from `[]*DatabaseRestoreResource` to `[]*RestorableMongodbResourcesGetResult`
+	Type of `RestorableSQLResourcesListResult.Value` has been changed from `[]*DatabaseRestoreResource` to `[]*RestorableSQLResourcesGetResult`

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-cosmosdb - 7.0.0b6

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 70efa69. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-cosmosdb [View full logs] [Release SDK Changes]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model DatabaseAccountCreateUpdateParameters has a new parameter keys_metadata
info	[Changelog]   - Model DatabaseAccountGetResults has a new parameter keys_metadata
info	[Changelog]   - Model DatabaseAccountUpdateParameters has a new parameter keys_metadata
info	[Changelog]   - Model GremlinGraphGetPropertiesResource has a new parameter analytical_storage_ttl
info	[Changelog]   - Model GremlinGraphResource has a new parameter analytical_storage_ttl

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 70efa69. 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
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.CosmosDB [View full logs] [Release SDK Changes]
- Azure.ResourceManager.CosmosDB.1.0.0-alpha.20220715.1.nupkg
- Azure.ResourceManager.CosmosDB.1.0.0-alpha.20220715.1.symbols.nupkg
```
info	[Changelog]
```

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 70efa69. 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

️✔️azure-resourcemanager-cosmos-generated [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 70efa69. 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

️✔️armcosmos [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `RestorableGremlinResourcesListResult.Value` has been changed from `[]*GremlinDatabaseRestoreResource` to `[]*RestorableGremlinResourcesGetResult`
info	[Changelog] - Type of `RestorableSQLResourcesListResult.Value` has been changed from `[]*DatabaseRestoreResource` to `[]*RestorableSQLResourcesGetResult`
info	[Changelog] - Type of `RestorableMongodbResourcesListResult.Value` has been changed from `[]*DatabaseRestoreResource` to `[]*RestorableMongodbResourcesGetResult`
info	[Changelog] - Type of `RestorableTableResourcesListResult.Value` has been changed from `[]*string` to `[]*RestorableTableResourcesGetResult`
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New struct `AccountKeyMetadata`
info	[Changelog] - New struct `DatabaseAccountKeysMetadata`
info	[Changelog] - New struct `RestorableGremlinResourcesGetResult`
info	[Changelog] - New struct `RestorableMongodbResourcesGetResult`
info	[Changelog] - New struct `RestorableSQLResourcesGetResult`
info	[Changelog] - New struct `RestorableTableResourcesGetResult`
info	[Changelog] - New field `AnalyticalStorageTTL` in struct `GremlinGraphGetPropertiesResource`
info	[Changelog] - New field `AnalyticalStorageTTL` in struct `GremlinGraphResource`
info	[Changelog] - New field `KeysMetadata` in struct `DatabaseAccountGetProperties`
info	[Changelog] - New field `KeysMetadata` in struct `DatabaseAccountCreateUpdateProperties`
info	[Changelog] - New field `KeysMetadata` in struct `DatabaseAccountUpdateProperties`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 17 additive change(s).

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from 70efa69. 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
cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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]

azure-arm-cosmosdb-15.1.0-beta.1.tgz

Only show 120 items here, please refer to log for details.

info	[Changelog]   - Added Type Alias CassandraClustersGetBackupResponse
info	[Changelog]   - Added Type Alias CassandraClustersListBackupsResponse
info	[Changelog]   - Added Type Alias CassandraResourcesCreateUpdateCassandraViewResponse
info	[Changelog]   - Added Type Alias CassandraResourcesGetCassandraViewResponse
info	[Changelog]   - Added Type Alias CassandraResourcesGetCassandraViewThroughputResponse
info	[Changelog]   - Added Type Alias CassandraResourcesListCassandraViewsResponse
info	[Changelog]   - Added Type Alias CassandraResourcesMigrateCassandraViewToAutoscaleResponse
info	[Changelog]   - Added Type Alias CassandraResourcesMigrateCassandraViewToManualThroughputResponse
info	[Changelog]   - Added Type Alias CassandraResourcesUpdateCassandraViewThroughputResponse
info	[Changelog]   - Added Type Alias CassandraViewCreateUpdateParameters
info	[Changelog]   - Added Type Alias CassandraViewGetPropertiesOptions
info	[Changelog]   - Added Type Alias CassandraViewGetPropertiesResource
info	[Changelog]   - Added Type Alias CassandraViewGetResults
info	[Changelog]   - Added Type Alias ClientEncryptionKeyGetPropertiesResource
info	[Changelog]   - Added Type Alias ClientEncryptionKeyGetResults
info	[Changelog]   - Added Type Alias ContinuousTier
info	[Changelog]   - Added Type Alias CosmosCassandraDataTransferDataSourceSink
info	[Changelog]   - Added Type Alias CosmosSqlDataTransferDataSourceSink
info	[Changelog]   - Added Type Alias CreateJobRequest
info	[Changelog]   - Added Type Alias DataTransferComponent
info	[Changelog]   - Added Type Alias DataTransferDataSourceSinkUnion
info	[Changelog]   - Added Type Alias DataTransferJobGetResults
info	[Changelog]   - Added Type Alias DataTransferJobsCancelResponse
info	[Changelog]   - Added Type Alias DataTransferJobsCreateResponse
info	[Changelog]   - Added Type Alias DataTransferJobsGetResponse
info	[Changelog]   - Added Type Alias DataTransferJobsListByDatabaseAccountNextResponse
info	[Changelog]   - Added Type Alias DataTransferJobsListByDatabaseAccountResponse
info	[Changelog]   - Added Type Alias DataTransferJobsPauseResponse
info	[Changelog]   - Added Type Alias DataTransferJobsResumeResponse
info	[Changelog]   - Added Type Alias DataTransferRegionalServiceResource
info	[Changelog]   - Added Type Alias DataTransferServiceResourceProperties
info	[Changelog]   - Added Type Alias EnableFullTextQuery
info	[Changelog]   - Added Type Alias GraphAPIComputeRegionalServiceResource
info	[Changelog]   - Added Type Alias GraphAPIComputeServiceResourceProperties
info	[Changelog]   - Added Type Alias GraphResourceCreateUpdateParameters
info	[Changelog]   - Added Type Alias GraphResourceGetPropertiesOptions
info	[Changelog]   - Added Type Alias GraphResourceGetPropertiesResource
info	[Changelog]   - Added Type Alias GraphResourceGetResults
info	[Changelog]   - Added Type Alias GraphResourcesCreateUpdateGraphResponse
info	[Changelog]   - Added Type Alias GraphResourcesGetGraphResponse
info	[Changelog]   - Added Type Alias GraphResourcesListGraphsResponse
info	[Changelog]   - Added Type Alias GremlinResourcesRetrieveContinuousBackupInformationResponse
info	[Changelog]   - Added Type Alias MaterializedViewsBuilderRegionalServiceResource
info	[Changelog]   - Added Type Alias MaterializedViewsBuilderServiceResourceProperties
info	[Changelog]   - Added Type Alias MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesCreateUpdateMongoUserDefinitionResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesGetMongoRoleDefinitionResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesGetMongoUserDefinitionResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesListMongoDBCollectionPartitionMergeResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesListMongoRoleDefinitionsResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesListMongoUserDefinitionsResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesMongoDBContainerRedistributeThroughputResponse
info	[Changelog]   - Added Type Alias MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse
info	[Changelog]   - Added Type Alias MongoRoleDefinitionGetResults
info	[Changelog]   - Added Type Alias MongoRoleDefinitionType
info	[Changelog]   - Added Type Alias MongoUserDefinitionGetResults
info	[Changelog]   - Added Type Alias PhysicalPartitionThroughputInfoResult
info	[Changelog]   - Added Type Alias PhysicalPartitionThroughputInfoResultPropertiesResource
info	[Changelog]   - Added Type Alias RedistributeThroughputParameters
info	[Changelog]   - Added Type Alias RestorableGremlinDatabasesListResponse
info	[Changelog]   - Added Type Alias RestorableGremlinGraphsListResponse
info	[Changelog]   - Added Type Alias RestorableGremlinResourcesListResponse
info	[Changelog]   - Added Type Alias RestorableTableResourcesListResponse
info	[Changelog]   - Added Type Alias RestorableTablesListResponse
info	[Changelog]   - Added Type Alias RetrieveThroughputParameters
info	[Changelog]   - Added Type Alias ServiceCreateResponse
info	[Changelog]   - Added Type Alias ServiceGetResponse
info	[Changelog]   - Added Type Alias ServiceListResponse
info	[Changelog]   - Added Type Alias ServiceResource
info	[Changelog]   - Added Type Alias ServiceResourcePropertiesUnion
info	[Changelog]   - Added Type Alias ServiceSize
info	[Changelog]   - Added Type Alias ServiceStatus
info	[Changelog]   - Added Type Alias ServiceType
info	[Changelog]   - Added Type Alias SqlDedicatedGatewayRegionalServiceResource
info	[Changelog]   - Added Type Alias SqlDedicatedGatewayServiceResourceProperties
info	[Changelog]   - Added Type Alias SqlResourcesCreateUpdateClientEncryptionKeyResponse
info	[Changelog]   - Added Type Alias SqlResourcesGetClientEncryptionKeyResponse
info	[Changelog]   - Added Type Alias SqlResourcesListClientEncryptionKeysResponse
info	[Changelog]   - Added Type Alias SqlResourcesListSqlContainerPartitionMergeResponse
info	[Changelog]   - Added Type Alias SqlResourcesSqlContainerRedistributeThroughputResponse
info	[Changelog]   - Added Type Alias SqlResourcesSqlContainerRetrieveThroughputDistributionResponse
info	[Changelog]   - Added Type Alias TableResourcesRetrieveContinuousBackupInformationResponse
info	[Changelog]   - Added Type Alias ThroughputPolicyType
info	[Changelog]   - Interface ARMResourceProperties has a new optional parameter identity
info	[Changelog]   - Interface DatabaseAccountUpdateParameters has a new optional parameter diagnosticLogSettings
info	[Changelog]   - Interface DatabaseAccountUpdateParameters has a new optional parameter enableMaterializedViews
info	[Changelog]   - Interface DatabaseAccountUpdateParameters has a new optional parameter keysMetadata
info	[Changelog]   - Interface DataCenterResourceProperties has a new optional parameter authenticationMethodLdapProperties
info	[Changelog]   - Interface GremlinGraphResource has a new optional parameter analyticalStorageTtl
info	[Changelog]   - Interface LocationProperties has a new optional parameter status
info	[Changelog]   - Interface RestorableDatabaseAccountGetResult has a new optional parameter oldestRestorableTime
info	[Changelog]   - Interface RestorableMongodbCollectionsListOptionalParams has a new optional parameter endTime
info	[Changelog]   - Interface RestorableMongodbCollectionsListOptionalParams has a new optional parameter startTime
info	[Changelog]   - Interface RestoreParameters has a new optional parameter gremlinDatabasesToRestore
info	[Changelog]   - Interface RestoreParameters has a new optional parameter tablesToRestore
info	[Changelog]   - Interface SqlContainerResource has a new optional parameter clientEncryptionPolicy
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter dataTransferJobs
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter graphResources
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter restorableGremlinDatabases
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter restorableGremlinGraphs
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter restorableGremlinResources
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter restorableTableResources
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter restorableTables
info	[Changelog]   - Class CosmosDBManagementClient has a new parameter service
info	[Changelog]   - Type Alias ContinuousModeBackupPolicy has a new parameter continuousModeProperties
info	[Changelog]   - Type Alias DatabaseAccountCreateUpdateParameters has a new parameter diagnosticLogSettings
info	[Changelog]   - Type Alias DatabaseAccountCreateUpdateParameters has a new parameter enableMaterializedViews
info	[Changelog]   - Type Alias DatabaseAccountCreateUpdateParameters has a new parameter keysMetadata
info	[Changelog]   - Type Alias DatabaseAccountGetResults has a new parameter diagnosticLogSettings
info	[Changelog]   - Type Alias DatabaseAccountGetResults has a new parameter enableMaterializedViews
info	[Changelog]   - Type Alias DatabaseAccountGetResults has a new parameter keysMetadata
info	[Changelog]   - Added Enum KnownContinuousTier
info	[Changelog]   - Added Enum KnownDataTransferComponent
info	[Changelog]   - Added Enum KnownServiceSize
info	[Changelog]   - Added Enum KnownServiceStatus
info	[Changelog]   - Added Enum KnownServiceType
info	[Changelog]   - Added Enum KnownThroughputPolicyType
info	[Changelog]   - Enum KnownAuthenticationMethod has a new value Ldap
info	[Changelog]   - Enum KnownServerVersion has a new value Four2
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 70efa69. 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] 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 70efa69. 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 [View full logs] [Release SDK Changes]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2022-07-08T13:12:41Z

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.

openapi-workflow-bot · 2022-07-08T15:07:07Z

Hi, @ekuhlmann23 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

openapi-workflow-bot · 2022-07-11T01:25:49Z

Hi @ekuhlmann23, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

akning-ms · 2022-07-11T01:26:55Z

@tadelesh to review GO SDK breaking change

pjohari-ms · 2022-07-11T23:35:18Z

@tadelesh Pinged you on teams for further discussion on the breaking change.

pjohari-ms · 2022-07-13T02:00:35Z

We recently introduced 2 PRs for 2 new API version: 1 for stable API and 1 for preview API version. We have a policy of having stable API changes also ported into the preview API version as well. Due to a mistake in merging, the preview API version PR had both the preview API changes, and the stable change, but not the stable API changes ported for preview version. This PR was merged a couple of weeks ago.

This PR is for the missing changes mentioned above. These changes are marked as breaking changes because these are changes to the existing preview API version. The thing is, we have not generated any SDK/CLI/PS yet for the preview version, and no official documentation have been generated for these API versions. So technically none of our users are using the newly introduced version. Do we still have to go through the breaking change process?

tadelesh · 2022-07-13T02:21:12Z

@JeffreyRichter Could you please to have a review?

pjohari-ms · 2022-07-15T00:14:28Z

/azp run

azure-pipelines · 2022-07-15T00:14:37Z

Azure Pipelines successfully started running 1 pipeline(s).

Erik Kuhlmann Salazar added 2 commits July 5, 2022 11:04

Port changes from 2022-05-15 to 2022-05-15-preview

950f2d2

Change wording in description of property.

d142ff6

openapi-pipeline-app bot added the NewApiVersionRequired label Jul 8, 2022

azure-sdk mentioned this pull request Jul 8, 2022

[AutoPR armcosmos] [Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2022-05-15-preview azure-sdk/azure-sdk-for-go#1699

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jul 8, 2022

ekuhlmann23 marked this pull request as ready for review July 8, 2022 13:44

ekuhlmann23 requested review from MehaKaushik and wmengmsft as code owners July 8, 2022 13:44

openapi-assignment-bot bot assigned akning-ms Jul 8, 2022

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 8, 2022

akning-ms added BreakingChangeReviewRequired and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 11, 2022

akning-ms removed the ARMReview label Jul 11, 2022

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 13, 2022

pjohari-ms self-requested a review July 15, 2022 00:12

pjohari-ms approved these changes Jul 15, 2022

View reviewed changes

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jul 15, 2022

tadelesh merged commit 70efa69 into Azure:main Jul 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2022-05-15-preview #19721

[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2022-05-15-preview #19721

ekuhlmann23 commented Jul 8, 2022 •

edited by akning-ms

Loading

openapi-workflow-bot bot commented Jul 8, 2022

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 8, 2022

openapi-workflow-bot bot commented Jul 8, 2022

openapi-workflow-bot bot commented Jul 11, 2022

akning-ms commented Jul 11, 2022

pjohari-ms commented Jul 11, 2022

pjohari-ms commented Jul 13, 2022

tadelesh commented Jul 13, 2022

pjohari-ms commented Jul 15, 2022

azure-pipelines bot commented Jul 15, 2022

[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2022-05-15-preview #19721

[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2022-05-15-preview #19721

Conversation

ekuhlmann23 commented Jul 8, 2022 • edited by akning-ms Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 8, 2022

openapi-pipeline-app bot commented Jul 8, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jul 8, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 8, 2022

openapi-workflow-bot bot commented Jul 8, 2022

openapi-workflow-bot bot commented Jul 11, 2022

akning-ms commented Jul 11, 2022

pjohari-ms commented Jul 11, 2022

pjohari-ms commented Jul 13, 2022

tadelesh commented Jul 13, 2022

pjohari-ms commented Jul 15, 2022

azure-pipelines bot commented Jul 15, 2022

ekuhlmann23 commented Jul 8, 2022 •

edited by akning-ms

Loading

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading