Updated Post APIs OperationId #29183

siddiavinashmsft · 2024-05-21T14:41:28Z

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-21T14:41:31Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-05-21T14:41:32Z

Swagger Validation Report

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

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

Rule	Message
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'CheckNameAvailability_Post' to 'CheckNameAvailability_CheckAvailability'. This will impact generated code. New: Microsoft.Help/preview/2024-03-01-preview/help.json#L75:7 Old: Microsoft.Help/preview/2024-03-01-preview/help.json#L75:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DiscoverySolutionNLPTenantScope_Post' to 'DiscoverySolutionNLP_DiscoverSolutions'. This will impact generated code. New: Microsoft.Help/preview/2024-03-01-preview/help.json#L815:7 Old: Microsoft.Help/preview/2024-03-01-preview/help.json#L815:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DiscoverySolutionNLPSubscriptionScope_Post' to 'DiscoverySolutionNLP_DiscoverSolutionsBySubscription'. This will impact generated code. New: Microsoft.Help/preview/2024-03-01-preview/help.json#L856:7 Old: Microsoft.Help/preview/2024-03-01-preview/help.json#L856:7

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2024-03-01-preview	package-2024-03-01-preview(c4dd5a4)	package-2024-03-01-preview(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_CheckAvailability'. Consider updating the operationId Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L80

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` XMSLongRunningOperationProperty	If an operation's (PUT/POST/PATCH/DELETE) responses have `Location` or `Azure-AsyncOperation` headers then it MUST have the property `x-ms-long-running-operation` set to `true` Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L674
`❌` XMSLongRunningOperationProperty	If an operation's (PUT/POST/PATCH/DELETE) responses have `Location` or `Azure-AsyncOperation` headers then it MUST have the property `x-ms-long-running-operation` set to `true` Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L715
`❌` XMSLongRunningOperationProperty	If an operation's (PUT/POST/PATCH/DELETE) responses have `Location` or `Azure-AsyncOperation` headers then it MUST have the property `x-ms-long-running-operation` set to `true` Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L756
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L927
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L941
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L941
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L957
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L967
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1259
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1270
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1288
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1308
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1739
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1739
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1753
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1765
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1955
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1969
⚠️ UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Solution_Create Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L466
⚠️ UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Solution_Get Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L503
⚠️ UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Solution_Get Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L807
⚠️ ListInOperationName	Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L815
⚠️ ListInOperationName	Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L856
⚠️ UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Discovery Solutions using issue summary and service id. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L892
⚠️ 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.Help/preview/2024-03-01-preview/help.json#L905
⚠️ AllProxyResourcesShouldHaveDelete	The resource DiagnosticResource does not have a corresponding delete operation. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L936
⚠️ AllProxyResourcesShouldHaveDelete	The resource SolutionResource does not have a corresponding delete operation. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1278
⚠️ AllProxyResourcesShouldHaveDelete	The resource SimplifiedSolutionsResource does not have a corresponding delete operation. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1729
⚠️ AllProxyResourcesShouldHaveDelete	The resource TroubleshooterResource does not have a corresponding delete operation. Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1945
⚠️ 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.Help/preview/2024-03-01-preview/help.json#L2080

️️✔️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-21T14:41:33Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

⚠️Warning in generating from fc08dd8. 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] 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.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-mgmt-selfhelp [Preview SDK Changes]
- azure_mgmt_selfhelp-1.0.0b1-py3-none-any.whl
- azure-mgmt-selfhelp-1.0.0b1.zip

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

️✔️Succeeded in generating from fc08dd8. 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-selfhelp [Preview SDK Changes]
- pom.xml
- azure-resourcemanager-selfhelp-1.1.0-beta.5-sources.jar
- azure-resourcemanager-selfhelp-1.1.0-beta.5.jar

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

️✔️Succeeded in generating from fc08dd8. 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

️✔️sdk/resourcemanager/selfhelp/armselfhelp [Preview SDK Changes]

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

️✔️Succeeded in generating from fc08dd8. 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-selfhelp [Preview SDK Changes]
- azure-arm-selfhelp-2.0.0-beta.5.tgz

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

❌Code Generator Failed in generating from fc08dd8. 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.8.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.8.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.8.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
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 fc08dd8. 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.help.DefaultTag [Preview SDK Changes]
- Az.HelpRp.0.1.0.nupkg

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

openapi-pipeline-app · 2024-05-21T14:41:33Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/selfhelp/armselfhelp	https://apiview.dev/Assemblies/Review/611de3dfe3a94edb9e893c2890467ac7?revisionId=4d164b184568441f97b74a97e37f039b
Java	azure-resourcemanager-selfhelp	https://apiview.dev/Assemblies/Review/bad59541f583478dae7ff6d7c0c71856?revisionId=79ee22fe14da48918da72261da39febf
JavaScript	@azure/arm-selfhelp	https://apiview.dev/Assemblies/Review/233f00ee3b4b4de68ccaf06651b6e931?revisionId=0094deb9346c4dae8e630089a7dbadf0
Swagger	Microsoft.Help	https://apiview.dev/Assemblies/Review/5f9147255c424e46b94f1735608a003e?revisionId=c2325078016d4100bfa98a5471a9733d

weidongxu-microsoft · 2024-05-22T01:15:26Z

specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/help.json

@@ -77,7 +77,7 @@
          "checkNameAvailability"
        ],
        "description": "This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions",
-        "operationId": "CheckNameAvailability_Post",
+        "operationId": "CheckNameAvailability_CheckAvailability",


In stable it is Diagnostics_CheckNameAvailability
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/help/resource-manager/Microsoft.Help/stable/2023-06-01/help.json#L80

SDK may have to do directive to rename it back, if this appear in next stable. #Resolved

weidongxu-microsoft · 2024-05-22T01:17:45Z

specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/help.json

@@ -858,7 +858,7 @@
          "discoverSolutions"
        ],
        "description": "Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.",
-        "operationId": "DiscoverySolutionNLPSubscriptionScope_Post",
+        "operationId": "DiscoverySolutionNLPSubscriptionScope_DiscoverSolutions",


The 2 DiscoverSolutions APIs (I assume they diff only on scope -- tenant vs. subscription?) may better be in same operation group, and diff by name, e.g. DiscoverSolutions and DiscoverSolutionsBySubscription #Resolved

Added this suggestion

siddiavinashmsft · 2024-05-23T13:11:29Z

/pr RequestMerge

Updated Post APIs OperationId

0ad6074

azure-sdk mentioned this pull request May 21, 2024

[AutoPR sdk/resourcemanager/selfhelp/armselfhelp] Updated Post APIs OperationId azure-sdk/azure-sdk-for-go#9921

Closed

weidongxu-microsoft reviewed May 22, 2024

View reviewed changes

Updated operationId for Discovery Solutions NLP APIs

c4dd5a4

JeffreyRichter added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label May 22, 2024

razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 22, 2024

microsoft-github-policy-service bot added the MergeRequested Part of the ARM PR review workflow label May 23, 2024

razvanbadea-msft approved these changes May 23, 2024

View reviewed changes

razvanbadea-msft merged commit 67f3f22 into main May 23, 2024
30 of 32 checks passed

razvanbadea-msft deleted the schenmilla/PostOpsIdUpdate branch May 23, 2024 14:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated Post APIs OperationId #29183

Updated Post APIs OperationId #29183

siddiavinashmsft commented May 21, 2024 •

edited by openapi-workflow-bot bot

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

edited

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

edited

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

edited

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

edited

weidongxu-microsoft May 22, 2024 •

edited by razvanbadea-msft

weidongxu-microsoft May 22, 2024 •

edited by razvanbadea-msft

siddiavinashmsft May 22, 2024 •

edited

siddiavinashmsft commented May 23, 2024

Updated Post APIs OperationId #29183

Updated Post APIs OperationId #29183

Conversation

siddiavinashmsft commented May 21, 2024 • edited by openapi-workflow-bot bot

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented May 21, 2024 • edited

Next Steps to Merge

openapi-pipeline-app bot commented May 21, 2024 • edited

Swagger Validation Report

openapi-pipeline-app bot commented May 21, 2024 • edited

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 21, 2024 • edited

Generated ApiView

weidongxu-microsoft May 22, 2024 • edited by razvanbadea-msft

Choose a reason for hiding this comment

weidongxu-microsoft May 22, 2024 • edited by razvanbadea-msft

Choose a reason for hiding this comment

siddiavinashmsft May 22, 2024 • edited

Choose a reason for hiding this comment

siddiavinashmsft commented May 23, 2024

siddiavinashmsft commented May 21, 2024 •

edited by openapi-workflow-bot bot

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

edited

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

edited

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

edited

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

edited

weidongxu-microsoft May 22, 2024 •

edited by razvanbadea-msft

weidongxu-microsoft May 22, 2024 •

edited by razvanbadea-msft

siddiavinashmsft May 22, 2024 •

edited