Update swagger to consume subscription id in method for Discover NLP … #28935

siddiavinashmsft · 2024-05-01T19:51:36Z

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.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

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 PR workflow diagram Step 2 (ARM review), 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.

…api at sub scope

openapi-pipeline-app · 2024-05-01T19:51:41Z

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-01T19:51:41Z

Swagger Validation Report

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

There are no breaking changes.

Compared specs (v0.10.8)	new version	base version
help.json	2024-03-01-preview(280a3bd)	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(280a3bd)	package-2024-03-01-preview(main)

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
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Post'. Consider updating the operationId Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L80
⚠️ 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
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'discoversolutions' in:'DiscoverySolutionNLPTenantScope_Post'. Consider updating the operationId Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L820
⚠️ 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
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'discoversolutions' in:'DiscoverySolutionNLPSubscriptionScope_Post'. Consider updating the operationId Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L861
⚠️ 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

️️✔️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-01T19:51:42Z

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 f920f9ae0ce81c4a3a748dea3e509d3fd3c05ba7. 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]
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
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 f920f9ae0ce81c4a3a748dea3e509d3fd3c05ba7. 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.4.jar
- azure-resourcemanager-selfhelp-1.1.0-beta.4-sources.jar

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

️✔️Succeeded in generating from f920f9ae0ce81c4a3a748dea3e509d3fd3c05ba7. 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 f920f9ae0ce81c4a3a748dea3e509d3fd3c05ba7. 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.4.tgz

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

❌Failed in generating from f920f9ae0ce81c4a3a748dea3e509d3fd3c05ba7. 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]  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
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
warn	No file changes detected after generation

❌help/resource-manager

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

️✔️Succeeded in generating from f920f9ae0ce81c4a3a748dea3e509d3fd3c05ba7. 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-01T19:51:42Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/selfhelp/armselfhelp	https://apiview.dev/Assemblies/Review/611de3dfe3a94edb9e893c2890467ac7?revisionId=2343d37102624824a17dd86a82b7d439
JavaScript	@azure/arm-selfhelp	https://apiview.dev/Assemblies/Review/233f00ee3b4b4de68ccaf06651b6e931?revisionId=ca893e65ada84064816de6e74e615158
Java	azure-resourcemanager-selfhelp	https://apiview.dev/Assemblies/Review/bad59541f583478dae7ff6d7c0c71856?revisionId=e3e43d338d3645a2ac1a9d2029e0568f
Swagger	Microsoft.Help	https://apiview.dev/Assemblies/Review/5f9147255c424e46b94f1735608a003e?revisionId=da06873731484ee08c8813d64c43b831

siddiavinashmsft · 2024-05-02T22:01:08Z

/pr RequestMerge

kazrael2119 · 2024-05-07T06:17:03Z

/azp run

azure-pipelines · 2024-05-07T06:17:21Z

Azure Pipelines successfully started running 4 pipeline(s).

…api at sub scope (Azure#28935)

Update swagger to consume subscription id in method for Discover NLP …

f090c53

…api at sub scope

azure-sdk mentioned this pull request May 1, 2024

[AutoPR sdk/resourcemanager/selfhelp/armselfhelp] Update swagger to consume subscription id in method for Discover NLP … azure-sdk/azure-sdk-for-go#9749

Closed

AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 1, 2024

TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 2, 2024

microsoft-github-policy-service bot added the MergeRequested label May 2, 2024

Merge branch 'main' into schenmilla/helpRpSwaggerUpdate

280a3bd

madhura-np approved these changes May 6, 2024

View reviewed changes

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

madhura-np merged commit d4240b3 into main May 8, 2024
30 of 32 checks passed

madhura-np deleted the schenmilla/helpRpSwaggerUpdate branch May 8, 2024 23:51

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

Update swagger to consume subscription id in method for Discover NLP …

fc7d884

…api at sub scope (Azure#28935)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update swagger to consume subscription id in method for Discover NLP … #28935

Update swagger to consume subscription id in method for Discover NLP … #28935

siddiavinashmsft commented May 1, 2024 •

edited by openapi-workflow-bot bot

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

siddiavinashmsft commented May 2, 2024

kazrael2119 commented May 7, 2024

azure-pipelines bot commented May 7, 2024

Update swagger to consume subscription id in method for Discover NLP … #28935

Update swagger to consume subscription id in method for Discover NLP … #28935

Conversation

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

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Diagram footnotes

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented May 1, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 1, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 1, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 1, 2024 • edited Loading

Generated ApiView

siddiavinashmsft commented May 2, 2024

kazrael2119 commented May 7, 2024

azure-pipelines bot commented May 7, 2024

siddiavinashmsft commented May 1, 2024 •

edited by openapi-workflow-bot bot

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading