S360 - Swagger Correctness - Microsoft.ResourceHealth #16920
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
fixed s360
|
Hi, @srrudray Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a new property 'title' in response that was not found in the old version. New: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L562:11 Old: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L557:11 |
️⚠️LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
| Rule | Message |
|---|---|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetHealthHistoryByResource Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L250 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ResourceHealth/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L174 |
|
The schema 'operationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L303 |
|
The schema 'operation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L318 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L559 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L175 |
|
| The API version:2020-05-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json#L4 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
This was referenced Nov 30, 2021
|
NewApiVersionRequired reason: |
|
Hi @srrudray, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @srrudray, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
fixed spaces
fixed ResourceHealth.json
fixed PR checks
openapi-pipeline-app
bot
added
BreakingChangeReviewRequired
and removed
BreakingChangeReviewRequired
labels
fixed PR checks
fixed PR checks
trying to fix
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ruowan
reviewed
Dec 29, 2021
| @@ -0,0 +1,154 @@ | |||
| { | |||
There was a problem hiding this comment.
The example format is wrong. Pls fix this example format.
fixed PR comment
openapi-pipeline-app
bot
added
NewApiVersionRequired
and removed
CI-FixRequiredOnFailure
labels
ruowan
approved these changes
Dec 29, 2021
This was referenced Dec 29, 2021
Closed
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
* Update ResourceHealth.json fixed s360 * Update AvailabilityStatus_GetByResource.json s360 * Update AvailabilityStatuses_List.json s360 * Update AvailabilityStatuses_ListByResourceGroup.json s360 * Update AvailabilityStatuses_ListByResourceGroup.json s360 * Update AvailabilityStatuses_ListBySubscriptionId.json s360 * Update AvailabilityStatus_GetByResource.json s360 * Update AvailabilityStatuses_List.json s360 * Update AvailabilityStatuses_ListByResourceGroup.json s360 * Update AvailabilityStatuses_ListByResourceGroup.json s360 * Update AvailabilityStatuses_ListBySubscriptionId.json s360 * Update ResourceHealth.json s360 * Update ResourceHealth.json removing the "title" change in Line 370 - see if checks will be good * Prettie changes * Update ResourceHealth.json fixing PR check Operations_List * Update ResourceHealth.json fixing PR checks * Update ResourceHealth.json fix PR checks 9:06AM * Update ResourceHealth.json fix PR checks * Update ResourceHealth.json fixed spaces * Update ResourceHealth.json fixed ResourceHealth.json * Create Operations_List.json fixed PR checks * Update ResourceHealth.json fixed PR checks * Update ResourceHealth.json fixed PR checks * Update ResourceHealth.json trying to fix * Prettie changes 2 files * Update Operations_List.json fixed PR comment
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.
fixed s360
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.