Fixing mongocluster by allenjzhang · Pull Request #29096 · Azure/azure-rest-api-specs

allenjzhang · 2024-05-14T06:55:55Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

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

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
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 OpenAPI spec 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 the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
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 · 2024-05-14T06:55:59Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
For details of the ARM review, see aka.ms/azsdk/pr-arm-review
❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram

openapi-pipeline-app · 2024-05-14T06:56:00Z

Swagger Validation Report

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

There are no breaking changes.

Compared specs (v0.10.8)	new version	base version
mongoCluster.json	2024-03-01-preview(cf33ffa)	2024-03-01-preview(main)

️️✔️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 specs (v2.2.2)	new version	base version
package-2024-03-01-preview	package-2024-03-01-preview(cf33ffa)	package-2024-03-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checkmongoclusternameavailability' in:'MongoClusters_CheckNameAvailability'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L97
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1522
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1541

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

Validation passes for Avocado.

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

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

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

openapi-pipeline-app · 2024-05-14T06:56:00Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

⚠️Warning in generating from e91646c91e12bfbbc29f088688c06f9bbec67145. 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.
cmderr	[automation_init.sh]  notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[automation_init.sh] npm notice
warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-mgmt-mongocluster [Preview SDK Changes]
- azure-mgmt-mongocluster-1.0.0b1.zip
- azure_mgmt_mongocluster-1.0.0b1-py3-none-any.whl
```
info	[Changelog]   - Initial Release
```

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

️✔️Succeeded in generating from e91646c91e12bfbbc29f088688c06f9bbec67145. 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-mongocluster [Preview SDK Changes]
- pom.xml
- azure-resourcemanager-mongocluster-1.0.0-beta.1-sources.jar
- azure-resourcemanager-mongocluster-1.0.0-beta.1.jar

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

️✔️Succeeded in generating from e91646c91e12bfbbc29f088688c06f9bbec67145. 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
warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/mongocluster/armmongocluster [Preview SDK Changes]

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

️✔️Succeeded in generating from e91646c91e12bfbbc29f088688c06f9bbec67145. 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-mongocluster [Preview SDK Changes]
- azure-arm-mongocluster-1.0.0-beta.1.tgz

️❌ azure-resource-manager-schemas failed [Detail]

❌Code Generator Failed in generating from e91646c91e12bfbbc29f088688c06f9bbec67145. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
cmderr	[initScript.sh]  notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[initScript.sh] npm notice
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
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
cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:500
cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
cmderr	[generateScript.sh]            ^
cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:500:12)
cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:504:19)
cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:739:36)
cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:955:32)
cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:1043:43)
cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:1046:12)
cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
warn	Skip package processing as generation is failed
warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-resource-manager-schemas not found in tspconfig.yaml
error	ERROR: The 'breakingChangesLabel' configuration is missing or incorrect from the 'swagger_to_sdk_config.json file.

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded in generating from e91646c91e12bfbbc29f088688c06f9bbec67145. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.mongocluster.DefaultTag [Preview SDK Changes]
- Az.MongoCluster.0.1.0.nupkg

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

openapi-pipeline-app · 2024-05-14T06:56:01Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/mongocluster/armmongocluster	https://apiview.dev/Assemblies/Review/b4d2bfc01ecb45d69db8ed292bcdf07d?revisionId=e963a59c1fb3436da9be2d78d62d1aa0
Java	azure-resourcemanager-mongocluster	https://apiview.dev/Assemblies/Review/89671bc422414e0f9adb9c49282e7e7f?revisionId=cdbc1a521c1d44d793ac487827ff984f
JavaScript	@azure/arm-mongocluster	https://apiview.dev/Assemblies/Review/95e9252dfc364a5fab7e6ea4e75639a9?revisionId=17fd3c92d1cf4d749f6b4d9763e12579
Swagger	Microsoft.DocumentDB	https://apiview.dev/Assemblies/Review/ac373549b7d34a108e5add93e45b3e3f?revisionId=161d674a11034882a3e14b6df78c8b24
TypeSpec	DocumentDB.MongoCluster.Management	https://apiview.dev/Assemblies/Review/48701a7bffad4d8aabeb332cf8f62e79?revisionId=2d8ac55c095f4a56aafcbff6e9854ca2

allenjzhang · 2024-05-14T07:36:34Z

@olivertowers, fixing some breaking changes in your previous PR and added optimization. No impact to swagger

unnecessary import
unused using
unnecessary custom op
@doc to /** */ for better visibility

...gocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json

Fixing mongocluster

617e783

azure-sdk mentioned this pull request May 14, 2024

[AutoPR sdk/resourcemanager/mongocluster/armmongocluster] Fixing mongocluster azure-sdk/azure-sdk-for-go#9893

Closed

Removing custom op & fixing up comments with /** */

f878708

allenjzhang requested review from mikeharder and olivertowers May 14, 2024 07:23

Merge branch 'main' into fixMongoCluster

0e6b74f

allenjzhang added MergeRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 14, 2024

allenjzhang commented May 14, 2024

View reviewed changes

...gocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json Show resolved Hide resolved

olivertowers approved these changes May 14, 2024

View reviewed changes

mikeharder approved these changes May 14, 2024

View reviewed changes

Merge branch 'main' into fixMongoCluster

cf33ffa

AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2024

mikeharder merged commit e21dcd7 into Azure:main May 14, 2024

Francisco-Gamino pushed a commit to Francisco-Gamino/azure-rest-api-specs that referenced this pull request Jun 5, 2024

[mongocluster] React to breaking changes in TypeSpec 0.56 (Azure#29096)

c3802d5

Copilot AI mentioned this pull request Oct 16, 2025

Generate SDKs for Microsoft.Mission TypeSpec project (Beta release) #38230

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing mongocluster #29096

Fixing mongocluster #29096
mikeharder merged 4 commits intoAzure:mainfrom
allenjzhang:fixMongoCluster

allenjzhang commented May 14, 2024 •

edited by openapi-workflow-bot bot

Loading

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

Uh oh!

allenjzhang commented May 14, 2024 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

allenjzhang commented May 14, 2024 • edited by openapi-workflow-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Uh oh!

openapi-pipeline-app bot commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

allenjzhang commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

allenjzhang commented May 14, 2024 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 14, 2024 •

edited

Loading

allenjzhang commented May 14, 2024 •

edited

Loading