fix swagger for metrics_list in post op #27386
Closed
Conversation
This file contains hidden or 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 MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| metrics_API.json | 2023-10-01(568880c) | 2023-10-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.1.6) | new version | base version |
|---|---|---|
| package-2023-10 | package-2023-10(568880c) | package-2023-10(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L38 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L169 |
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L46 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L49 |
|
| OperationId should contain the verb: 'metrics' in:'Metrics_ListAtSubscriptionScopePost'. Consider updating the operationId Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L119 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L123 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L126 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L204 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-10-01/metrics_API.json#L223 |
|
| 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.Insights/stable/2023-10-01/metrics_API.json#L302 |
|
| 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.Insights/stable/2023-10-01/metrics_API.json#L306 |
|
| 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.Insights/stable/2023-10-01/metrics_API.json#L417 |
|
| 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.Insights/stable/2023-10-01/metrics_API.json#L425 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2023-10 |
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMChangesRequested
ARMReview
BreakingChangeReviewRequired
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Jan 16, 2024
Closed
3 tasks
microsoft-github-policy-service
bot
added
no-recent-activity
Contributor
|
Hi, @AllyW. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
microsoft-github-policy-service
bot
added
the
no-recent-activity
Contributor
|
Hi, @AllyW. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
Contributor
|
Hi, @AllyW. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
1 similar comment
Contributor
|
Hi, @AllyW. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
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 (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReviewlabel.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
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] 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 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
Swagger-Suppression-Process
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.