Convert two operations to be async #28350
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| privateAccesses.json | 2024-03-22-preview(2437e50) | 2023-10-27-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version adds a response code '202'. New: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L259:11 |
|
| The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L176:7 Old: Microsoft.Chaos/preview/2023-10-27-preview/privateAccesses.json#L176:7 |
|
| The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L238:7 Old: Microsoft.Chaos/preview/2023-10-27-preview/privateAccesses.json#L231:7 |
️❌LintDiff: 4 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-03 | package-preview-2024-03(2437e50) | package-preview-2024-03(MasterRyd3l-chaos-Microsoft.Chaos-2024-03-22-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L176 |
|
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L176 |
|
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L238 |
RPC-Delete-V1-01 |
|
A 202 response should include an Location response header. Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L259 |
RPC-Async-V1-07 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L52 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L94 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L139 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L182 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L244 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L281 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L287 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L332 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L375 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2024-03-22-preview/privateAccesses.json#L429 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 10 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Mar 20, 2024
Draft
Closed
MasterRyd3l
reviewed
Mar 20, 2024
| @@ -222,6 +222,10 @@ | |||
| } | |||
| } | |||
| }, | |||
| "x-ms-long-running-operation-options": { | |||
| "final-state-via": "location" | |||
There was a problem hiding this comment.
for put, use the azure-async-operation header instead of location. azure-async-operation header includes a payload.
MasterRyd3l
reviewed
Mar 21, 2024
| @@ -255,6 +259,9 @@ | |||
| "200": { | |||
There was a problem hiding this comment.
delete is only 202. the location header url needs to return either 200 or 204.
MasterRyd3l
approved these changes
Mar 22, 2024
MasterRyd3l
merged commit f569d71
into
MasterRyd3l-chaos-Microsoft.Chaos-2024-03-22-preview
22 of 27 checks passed
MasterRyd3l
deleted the
rui-async-chaos-Microsoft.Chaos-2024-03-22-preview
branch
MasterRyd3l
pushed a commit
that referenced
this pull request
Mar 22, 2024
* Convert two operations to be async * Fix examples * Resolve comments * Change delete async operation status code
mentat9
pushed a commit
that referenced
this pull request
May 13, 2024
* Adds base for updating Microsoft.Chaos from version preview/2023-10-27-preview to version 2024-03-22-preview * Updates readme * Updates API version in new specs and examples * merge in 2024-01-01 stable branch additions * Add PublicNetworkAccess Field under privateAccesses resource (#28110) * Add new field for privateAccess * Fix reference * Fix PublicNetworkAccess definition * Fix PrettierCheck * Fix enum name * Rename enum property * Test my push permission * Adds base for updating Microsoft.Chaos from version preview/2023-10-27-preview to version 2024-03-22-preview * Updates readme * Updates API version in new specs and examples * merge in 2024-01-01 stable branch additions * Add PublicNetworkAccess Field under privateAccesses resource (#28110) * Add new field for privateAccess * Fix reference * Fix PublicNetworkAccess definition * Fix PrettierCheck * Fix enum name * Rename enum property * Convert two operations to be async (#28350) * Convert two operations to be async * Fix examples * Resolve comments * Change delete async operation status code * Added Patch Tags Endpoint to Private Link (#28296) * Added UpdatePrivateAccessTags endpoint * Addressing points for the PR review, it was about rename the new private link endpoint to PrivateAccesses_Patch, and changned the return code from 200 to 202 * Update the Private Access tags payload --------- Co-authored-by: Adi Hazeem <[email protected]> * update readme * Resolved conflict * Resolved conflict * Resolved conflict * Fix linting error for PUT and DELETE (#28417) * Fix check error * move readonly flag * Added 200 response to PrivateAccess Tags Patch Endpoint (#28465) * Added 200 response to PrivateAccess Tags example --------- Co-authored-by: Adi Hazeem <[email protected]> * add missing LRO header to open api spec * attempted model validation fix * fixed prop spelling mistake * prettier * remove unused example file * move common type definition to pick up from latest official typing file * move common type definition to pick up from latest official typing file (#28870) Co-authored-by: James Duan <[email protected]> * fix id format in sample file * address review comments from Tim (#28991) Co-authored-by: James Duan <[email protected]> --------- Co-authored-by: James Duan <[email protected]> Co-authored-by: RayY-96 <[email protected]> Co-authored-by: Adi Hazeem <[email protected]> Co-authored-by: Adi Hazeem <[email protected]> Co-authored-by: Brent Rusinow (from Dev Box) <[email protected]>
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
* Adds base for updating Microsoft.Chaos from version preview/2023-10-27-preview to version 2024-03-22-preview * Updates readme * Updates API version in new specs and examples * merge in 2024-01-01 stable branch additions * Add PublicNetworkAccess Field under privateAccesses resource (Azure#28110) * Add new field for privateAccess * Fix reference * Fix PublicNetworkAccess definition * Fix PrettierCheck * Fix enum name * Rename enum property * Test my push permission * Adds base for updating Microsoft.Chaos from version preview/2023-10-27-preview to version 2024-03-22-preview * Updates readme * Updates API version in new specs and examples * merge in 2024-01-01 stable branch additions * Add PublicNetworkAccess Field under privateAccesses resource (Azure#28110) * Add new field for privateAccess * Fix reference * Fix PublicNetworkAccess definition * Fix PrettierCheck * Fix enum name * Rename enum property * Convert two operations to be async (Azure#28350) * Convert two operations to be async * Fix examples * Resolve comments * Change delete async operation status code * Added Patch Tags Endpoint to Private Link (Azure#28296) * Added UpdatePrivateAccessTags endpoint * Addressing points for the PR review, it was about rename the new private link endpoint to PrivateAccesses_Patch, and changned the return code from 200 to 202 * Update the Private Access tags payload --------- Co-authored-by: Adi Hazeem <[email protected]> * update readme * Resolved conflict * Resolved conflict * Resolved conflict * Fix linting error for PUT and DELETE (Azure#28417) * Fix check error * move readonly flag * Added 200 response to PrivateAccess Tags Patch Endpoint (Azure#28465) * Added 200 response to PrivateAccess Tags example --------- Co-authored-by: Adi Hazeem <[email protected]> * add missing LRO header to open api spec * attempted model validation fix * fixed prop spelling mistake * prettier * remove unused example file * move common type definition to pick up from latest official typing file * move common type definition to pick up from latest official typing file (Azure#28870) Co-authored-by: James Duan <[email protected]> * fix id format in sample file * address review comments from Tim (Azure#28991) Co-authored-by: James Duan <[email protected]> --------- Co-authored-by: James Duan <[email protected]> Co-authored-by: RayY-96 <[email protected]> Co-authored-by: Adi Hazeem <[email protected]> Co-authored-by: Adi Hazeem <[email protected]> Co-authored-by: Brent Rusinow (from Dev Box) <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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!
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:
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 ApiViewcomment 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
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.