[Hub Generated] Review request for Microsoft.Help to add version stable/2023-06-01 #23956

arthurwang2021 · 2023-05-12T17:02:47Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. 2023-06
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

…-preview to version 2023-06-01

openapi-pipeline-app · 2023-05-12T17:02:51Z

Swagger Validation Report

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

There are no breaking changes.

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

compared swaggers (via Oad v0.10.4)]	new version	base version
help.json	2023-06-01(ecb5b71)	2023-01-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
⚠️ 1011 - AddingResponseCode	The new version adds a response code '200'. New: Microsoft.Help/stable/2023-06-01/help.json#L158:11

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-2023-06-01	package-2023-06-01(ecb5b71)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/stable/2023-06-01/help.json#L44
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/stable/2023-06-01/help.json#L44
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/stable/2023-06-01/help.json#L81
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/stable/2023-06-01/help.json#L81
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/stable/2023-06-01/help.json#L132
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/stable/2023-06-01/help.json#L132
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/stable/2023-06-01/help.json#L183
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/stable/2023-06-01/help.json#L183
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/stable/2023-06-01/help.json#L222
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/stable/2023-06-01/help.json#L222
⚠️ 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/stable/2023-06-01/help.json#L266
⚠️ AllProxyResourcesShouldHaveDelete	The resource DiagnosticResource does not have a corresponding delete operation. Location: Microsoft.Help/stable/2023-06-01/help.json#L297

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

Validation passes for Avocado.

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

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Help' for api version '2023-06-01'. The supported api-versions are '2023-01-01-preview, 2023-03-03-preview, 2023-03-23-preview'."

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

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

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

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

Validation passes for Summary.

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

openapi-workflow-bot · 2023-05-12T17:02:51Z

Hi, @arthurwang2021 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-05-12T17:02:52Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

Breaking Changes Tracking

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

⚠️Warning [Logs]Release - Generate from c2c2f7a. 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.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-selfhelp [View full logs] [Release SDK Changes]
- azure_mgmt_selfhelp-1.0.0b1-py3-none-any.whl
- azure-mgmt-selfhelp-1.0.0b1.zip
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from c2c2f7a. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-selfhelp [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from c2c2f7a. 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 [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from c2c2f7a. 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
cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.

️✔️@azure/arm-selfhelp [View full logs] [Release SDK Changes]

azure-arm-selfhelp-1.0.0-beta.1.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

❌Failed [Logs]Release - Generate from c2c2f7a. 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]  WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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 [View full logs]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from c2c2f7a. 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
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.help.DefaultTag [View full logs]

Az.HelpRp.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.help.DefaultTag

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

openapi-pipeline-app · 2023-05-12T17:02:53Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/selfhelp/armselfhelp	https://apiview.dev/Assemblies/Review/07d3a628769044f580322d8060e9f329
Java	azure-resourcemanager-selfhelp	There is no API change compared with the previous version
JavaScript	@azure/arm-selfhelp	https://apiview.dev/Assemblies/Review/d2302e7dcc2346f8a47e6564e135ef6b

openapi-workflow-bot · 2023-05-12T17:03:47Z

Hi, @arthurwang2021 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

arthurwang2021 · 2023-05-16T18:45:28Z

This is a stable version of the preview version 2023-01-01-preview. The preview version has been approved and merged into the public repo.

kazrael2119 · 2023-05-17T02:29:57Z

This is a stable version of the preview version 2023-01-01-preview. The preview version has been approved and merged into the public repo.

can you link the preview version pr ?
And is there any new changes between this stable and preview?

arthurwang2021 · 2023-05-17T13:38:50Z

This is a stable version of the preview version 2023-01-01-preview. The preview version has been approved and merged into the public repo.

can you link the preview version pr ? And is there any new changes between this stable and preview?

Sure. The preview version is 2023-01-01-preview. https://github.com/Azure/azure-rest-api-specs/tree/main/specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview No breaking changes. Except for some minor change on examples to make it look better and for better SDK generation.

kazrael2119 · 2023-05-18T02:23:27Z

/azp run

azure-pipelines · 2023-05-18T02:23:52Z

Azure Pipelines successfully started running 1 pipeline(s).

arthurwang2021 added 4 commits May 12, 2023 12:20

Adds base for updating Microsoft.Help from version preview/2023-01-01…

3e356b8

…-preview to version 2023-06-01

Updates readme

e599ab8

Updates API version in new specs and examples

1b51a60

Added additional status code for azure powershell cmdlet.

2f59f5b

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 12, 2023

arthurwang2021 removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 12, 2023

AzureRestAPISpecReview added new-api-version resource-manager labels May 12, 2023

arthurwang2021 added 2 commits May 12, 2023 13:30

Updated the description for 200&201 status code.

b7c23e6

Rephrase the description.

ecb5b71

arthurwang2021 marked this pull request as ready for review May 16, 2023 18:42

openapi-assignment-bot bot assigned kazrael2119 May 16, 2023

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 16, 2023

BharathaAravind self-requested a review May 17, 2023 16:26

BharathaAravind approved these changes May 17, 2023

View reviewed changes

raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 17, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 17, 2023

kazrael2119 approved these changes May 18, 2023

View reviewed changes

kazrael2119 added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 18, 2023

AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label May 18, 2023

tadelesh merged commit c2c2f7a into main May 18, 2023

tadelesh deleted the arthurwang2021-help-Microsoft.Help-2023-06-01 branch May 18, 2023 02:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Review request for Microsoft.Help to add version stable/2023-06-01 #23956

[Hub Generated] Review request for Microsoft.Help to add version stable/2023-06-01 #23956

arthurwang2021 commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 12, 2023

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 12, 2023

arthurwang2021 commented May 16, 2023

kazrael2119 commented May 17, 2023

arthurwang2021 commented May 17, 2023

kazrael2119 commented May 18, 2023

azure-pipelines bot commented May 18, 2023

[Hub Generated] Review request for Microsoft.Help to add version stable/2023-06-01 #23956

[Hub Generated] Review request for Microsoft.Help to add version stable/2023-06-01 #23956

Conversation

arthurwang2021 commented May 12, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented May 12, 2023 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented May 12, 2023

openapi-pipeline-app bot commented May 12, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 12, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented May 12, 2023

arthurwang2021 commented May 16, 2023

kazrael2119 commented May 17, 2023

arthurwang2021 commented May 17, 2023

kazrael2119 commented May 18, 2023

azure-pipelines bot commented May 18, 2023

arthurwang2021 commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading