Initial TSP conversion of Microsoft.DocumentDB

[dvbb]

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

• New API version. (Such PR should have been generated with OpenAPI Hub).
• Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
• Update existing version to fix swagger quality issues in S360.
• Other, please clarify:
  • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

• I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
• I have reviewed following Resource Provider guidelines, including
  ARM resource provider contract and
  REST guidelines (estimated time: 4 hours).
  I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

Breaking changes review (Step 1)

• If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
  you must follow the breaking changes process.
  IMPORTANT This applies even if:
  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

• If this PR is in purview of ARM review then automation will add the ARMReview label.
• If you want to force ARM review, add the label yourself.
• Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

• For general PR approval workflow, see the diagram at the top of this comment.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

[openapi-pipeline-app]

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

[openapi-pipeline-app]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 2 Warnings warning [Detail]

Rule	Message
⚠️ APIsBeingMovedToANewSpec	"details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:MongoClusters_ListConnectionStrings;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmosdbmongocluster/resource-manager/Microsoft.DocumentDB/stable/2023-10-01/Origin.json"
⚠️ APIsBeingMovedToANewSpec	"details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:MongoClusters_ListConnectionStrings;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmosdbmongocluster/resource-manager/Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json"

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

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️❌Avocado: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: resource-manager/Microsoft.DocumentDB/stable/2023-10-01

️❌SwaggerAPIView: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log.	"How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️❌ModelValidation: 15 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in Operations_List. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L54:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClustersOperations_CheckNameAvailability. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L85:15
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_List. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L140:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_ListByResourceGroup. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L174:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_Get. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L211:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_CreateOrUpdate. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L253:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_Update. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L321:16
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_Delete. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L390:17
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in FirewallRules_ListByMongoCluster. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L449:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in FirewallRules_GetFirewallRule. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L496:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in FirewallRules_CreateOrUpdateFirewallRule. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L548:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in FirewallRules_DeleteFirewallRule. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L626:17
❌ XMS_EXAMPLE_NOTFOUND_ERROR	x-ms-example not found in MongoClusters_ListConnectionStrings. Url: Microsoft.DocumentDB/stable/2023-10-01/mongoCluster.json#L695:15
❌ unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/de481f70e815ce3287a7817a362d914e272f3304/specification/cosmosdbmongocluster/resource-manager/Microsoft.DocumentDB/stable/2023-10-01/Origin.json"
❌ unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/de481f70e815ce3287a7817a362d914e272f3304/specification/cosmosdbmongocluster/resources.json"

️❌SemanticValidation: 5 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ INTERNAL_ERROR	Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/cosmosdbmongocluster/resource-manager/Microsoft.DocumentDB/stable/2023-10-01/examples/OperationsList.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/cosmosdbmongocluster/resource-manager/Microsoft.DocumentDB/stable/2023-10-01/examples/OperationsList.json' JsonUrl: Microsoft.DocumentDB/stable/2023-10-01/Origin.json
❌ OBJECT_MISSING_REQUIRED_PROPERTY	Missing required property: swagger JsonUrl: de481f70e815ce3287a7817a362d914e272f3304/specification/cosmosdbmongocluster/resources.json
❌ OBJECT_MISSING_REQUIRED_PROPERTY	Missing required property: info JsonUrl: de481f70e815ce3287a7817a362d914e272f3304/specification/cosmosdbmongocluster/resources.json
❌ OBJECT_MISSING_REQUIRED_PROPERTY	Missing required property: paths JsonUrl: de481f70e815ce3287a7817a362d914e272f3304/specification/cosmosdbmongocluster/resources.json
❌ OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: Resources JsonUrl: de481f70e815ce3287a7817a362d914e272f3304/specification/cosmosdbmongocluster/resources.json

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

[openapi-pipeline-app]

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ RestBuild error	"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=399542&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 "

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
TypeSpec	DocumentDB.Management	https://apiview.dev/Assemblies/Review/686867c843594398b5cfc4d2482aebcc

[openapi-workflow-bot]

Hi @dvbb! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

[openapi-workflow-bot]

Hi, @dvbb, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
Action Required:

Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.

Paste the issue link that you created in step 1 in this PR

Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

[openapi-workflow-bot]

Hi @dvbb This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

[openapi-pipeline-app]

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.