[Hub Generated] Review request for Microsoft.Help to add version preview/2023-09-01-preview #26204
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! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| help.json | 2023-09-01-preview(27c441f) | 2023-09-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 tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-09-01-preview | package-2023-09-01-preview(27c441f) | package-2023-09-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 |
|---|---|
|
Path '/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}' that has the scope parameter.'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L422 |
|
Path '/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}' that has the scope parameter.'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L422 |
|
Path '/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}' that has the scope parameter.'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L422 |
|
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 trueLocation: Microsoft.Help/preview/2023-09-01-preview/help.json#L542 |
|
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 trueLocation: Microsoft.Help/preview/2023-09-01-preview/help.json#L583 |
|
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 trueLocation: Microsoft.Help/preview/2023-09-01-preview/help.json#L624 |
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L44 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L44 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L44 |
|
| OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Post'. Consider updating the operationId Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L80 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L81 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L81 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L81 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L132 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L132 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L132 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L183 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L183 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L183 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L222 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L222 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L222 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L274 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L274 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L274 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L325 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L325 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L325 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L366 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Help/preview/2023-09-01-preview/help.json#L366 |
️️✔️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.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
ReadyForApiTest
This was referenced Oct 12, 2023
|
@AzureRestAPISpecReview we have only updated doc. Can you please review and merge the PR? |
ms-henglu
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
AzureRestAPISpecReview
added
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@AzureRestAPISpecReview can you please add tags for Approved-SdkBreakingChange-Go and Approved-SdkBreakingChange-Python since I want to merge this PR? |
|
/pr RequestMerge |
zizw123
approved these changes
Nov 9, 2023
|
Removing from the merge queue for now, once the approve label is there, add back the label and we can help with merging it. |
Alancere
added
the
Approved-SdkBreakingChange-Go
|
/pr RequestMerge |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
TimLovellSmith
deleted the
sahilpwr-help-Microsoft.Help-2023-09-01-preview-update
branch
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Sep 19, 2023
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
…iew/2023-09-01-preview (#26204)
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.