azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Fix MongoCluster patch operations
Choose a PR Template
Switch to "Preview" on this description then select one of the choices below.
Click here to open a PR for a Data Plane API.
Click here to open a PR for a Control Plane (ARM) API.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ This is the public specs repo
mainbranch which is not intended for iterative development.
You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
If this is what you intend, addPublishToCustomerslabel to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefixrelease-(see aka.ms/azsdk/api-versions#release--branches). - ❌ This PR is in purview of the ARM review (label:
ARMReview). This PR must getARMSignedOfflabel from an ARM reviewer.
This PR is not ready for ARM review (label:NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of thisNext Steps to Mergecomment for details.
Once the blocking problems are addressed, add to the PR a comment with contents/azp run. Automation will re-evaluate this PR and if everything looks good, it will addWaitForARMFeedbacklabel which will put this PR on the ARM review queue.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review - ❌ This PR is
NotReadyForARMReviewbecause it has theVersioningReviewRequiredlabel. - ❌ This PR has at least one change violating Azure versioning policy (label:
VersioningReviewRequired).
To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch. - ❌ The required check named
Swagger ModelValidationhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 6 Errors, 1 Warnings failed [Detail]
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| mongoCluster.json | 2024-03-01-preview(e125087) | 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: 1 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-03-01-preview | package-2024-03-01-preview(e125087) | package-2024-03-01-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Properties of a PATCH request body must not be required, property:location. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L382 |
RPC-Patch-V1-10 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L604 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L919 |
| :warning: 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 |
| :warning: 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#L1441 |
| :warning: 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#L1460 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Missing required property: location Url: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1239:21 ExampleUrl: preview/2024-03-01-preview/examples/MongoClusters_PatchPrivateNetworkAccess.json#L9:19 |
|
Missing required property: location Url: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1239:21 ExampleUrl: preview/2024-03-01-preview/examples/MongoClusters_Update.json#L9:19 |
|
Missing required property: location Url: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1239:21 ExampleUrl: preview/2024-03-01-preview/examples/MongoClusters_PatchDiskSize.json#L9:19 |
️️✔️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]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️🔄 azure-sdk-for-python-track2 inProgress [Detail]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from 6f74a3ed7b5a55e33e5b0c53592ccff924355cd1. SDK Automation 14.0.0command ./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]info [Changelog]
️✔️azure-resourcemanager-mongocluster [Preview SDK Changes]info [Changelog]
️❌ azure-sdk-for-go failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from 6f74a3ed7b5a55e33e5b0c53592ccff924355cd1. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json warn Warning: cannot find emitter config for azure-sdk-for-go in tspconfig.yaml for typespec project specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml. command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json cmderr [generator automation-v2] [ERROR] total 1 error(s): cmderr [generator automation-v2] [ERROR] open /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mongocluster/armmongocluster/autorest.md: no such file or directory error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2 warn Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from 6f74a3ed7b5a55e33e5b0c53592ccff924355cd1. Schema Automation 14.0.0command .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] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1 cmderr [initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1 cmderr [initScript.sh] npm notice To update run: npm install -g [email protected] cmderr [initScript.sh] npm notice error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh warn Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. 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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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 Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel. warn Warning: cannot find emitter config for azure-resource-manager-schemas in tspconfig.yaml for typespec project specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml.
️️✔️ azure-powershell succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from 6f74a3ed7b5a55e33e5b0c53592ccff924355cd1. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json warn Warning: cannot find emitter config for azure-powershell in tspconfig.yaml for typespec project specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml. command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.mongocluster.DefaultTag [Preview SDK Changes]
️⚠️ azure-sdk-for-python warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from 6f74a3ed7b5a55e33e5b0c53592ccff924355cd1. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. cmderr [automation_init.sh] npm notice cmderr [automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1 cmderr [automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1 cmderr [automation_init.sh] npm notice To update run: npm install -g [email protected] cmderr [automation_init.sh] npm notice warn Warning: azure-sdk-for-python cannot be found in specification/mongocluster/resource-manager/readme.md. This SDK will be skipped from SDK generation. Please add the right config to the readme file according to this guidance https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/code-gen/configure-go-sdk.md#swagger-to-sdk. 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]info [Changelog]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Java | azure-resourcemanager-mongocluster | https://apiview.dev/Assemblies/Review/89671bc422414e0f9adb9c49282e7e7f?revisionId=ba924ef8e3ef422299014b4e288c10be |
| TypeSpec | DocumentDB.MongoCluster.Management | https://apiview.dev/Assemblies/Review/48701a7bffad4d8aabeb332cf8f62e79?revisionId=b7b375ff0c8949498c6681aa56ea31ee |
| Swagger | Microsoft.DocumentDB | https://apiview.dev/Assemblies/Review/ac373549b7d34a108e5add93e45b3e3f?revisionId=4acd11f7c6d34fe68ef9532c7db48a2a |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @pshao25. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @pshao25. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.