Add Azure-AsyncOperation header to async operations by yjsong11 · Pull Request #23410 · Azure/azure-rest-api-specs

yjsong11 · 2023-04-03T20:27:39Z

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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.
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.

openapi-workflow-bot · 2023-04-03T20:27:43Z

Hi, @yjsong11 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-04-03T20:27:43Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
grafana.json	2022-08-01(2278857)	2022-08-01(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 tags (via openapi-validator v2.0.0)	new version	base version
package-2022-08-01	package-2022-08-01(2278857)	package-2022-08-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ ParameterDescription	Parameter should have a description. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L214
⚠️ LroExtension	Operations with a 202 response should specify `x-ms-long-running-operation: true`. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L259
⚠️ ParameterDescription	Parameter should have a description. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L284
⚠️ PutInOperationName	'PUT' operation 'PrivateEndpointConnections_Approve' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L434
⚠️ ParameterDescription	Parameter should have a description. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L457
⚠️ ParameterDescription	Parameter should have a description. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L671
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L725
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L759
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L847
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L878
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L897
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L908
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L920
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L932

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[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-pipeline-app · 2023-04-03T20:27:44Z

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-net-track2 failed [Detail]

❌Failed [Logs]Release - Generate from 75ece91. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:671
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:671
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to packe sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:759
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 759 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:671
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.ResourceManager.Dashboard [View full logs] [Release SDK Changes]
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 75ece91. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.3
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.3>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.3` to update!
cmderr	[automation_generate.sh] npm notice

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

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

️✔️Succeeded [Logs]Release - Generate from 75ece91. 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/dashboard/armdashboard [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `AzureAsyncOperation` in struct `GrafanaClientUpdateResponse`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 1 additive change(s).

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 75ece91. 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

️✔️dashboard [View full logs]

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

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

azure-arm-dashboard-1.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface GrafanaCreateHeaders
info	[Changelog]   - Added Interface GrafanaDeleteHeaders
info	[Changelog]   - Added Interface GrafanaUpdateHeaders
info	[Changelog]   - Added Interface PrivateEndpointConnectionsApproveHeaders
info	[Changelog]   - Added Interface PrivateEndpointConnectionsDeleteHeaders
info	[Changelog]   - Added Type Alias PrivateEndpointConnectionsDeleteResponse
info	[Changelog]   - Add parameters of PrivateEndpointConnectionsApproveHeaders to TypeAlias PrivateEndpointConnectionsApproveResponse

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

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

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

️✔️Succeeded [Logs]Release - Generate from 75ece91. 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.dashboard.DefaultTag [View full logs] [Release SDK Changes]
- Az.Dashboard.0.1.0.nupkg

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

openapi-pipeline-app · 2023-04-03T20:27:45Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/dashboard/armdashboard	https://apiview.dev/Assemblies/Review/ff85592f77894f13a5e2dcc6c70e6c76
Java	azure-resourcemanager-dashboard	https://apiview.dev/Assemblies/Review/b9b3d0ebf92c414d97d6409d2a876c75
JavaScript	@azure/arm-dashboard	https://apiview.dev/Assemblies/Review/21e322c2d8bb4631ab3efd4fd4945c7a

openapi-workflow-bot · 2023-04-03T20:37:33Z

Hi @yjsong11, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

* add * fix --------- Co-authored-by: Younjin Song <younjinsong@microsoft.com>

add

6c33137

openapi-assignment-bot bot assigned tadelesh Apr 3, 2023

openapi-workflow-bot bot added the FixS360 label Apr 3, 2023

azure-sdk mentioned this pull request Apr 3, 2023

[AutoPR sdk/resourcemanager/dashboard/armdashboard] Add Azure-AsyncOperation header to async operations azure-sdk/azure-sdk-for-go#5185

Closed

AzureRestAPISpecReview added CI-FixRequiredOnFailure resource-manager RPaaS labels Apr 3, 2023

fix

2278857

AzureRestAPISpecReview removed the CI-FixRequiredOnFailure label Apr 3, 2023

tadelesh approved these changes Apr 4, 2023

View reviewed changes

tadelesh merged commit 75ece91 into Azure:main Apr 4, 2023

JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023

Add Azure-AsyncOperation header to async operations (Azure#23410)

955ae9f

* add * fix --------- Co-authored-by: Younjin Song <younjinsong@microsoft.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Azure-AsyncOperation header to async operations#23410

Add Azure-AsyncOperation header to async operations#23410
tadelesh merged 2 commits intoAzure:mainfrom
yjsong11:yjsong/header

yjsong11 commented Apr 3, 2023

Uh oh!

openapi-workflow-bot bot commented Apr 3, 2023

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Apr 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

yjsong11 commented Apr 3, 2023

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Apr 3, 2023

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2023 • 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 Apr 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

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

Uh oh!

Generated ApiView

Uh oh!

openapi-workflow-bot bot commented Apr 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

openapi-pipeline-app bot commented Apr 3, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 3, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 3, 2023 •

edited

Loading