-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Adding missing / in path #12905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding missing / in path #12905
Conversation
Found a path with a missing /
|
Hi, @emontgomerydae 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. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}resourceGroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices/{serviceName}' removed or restructured? Old: Microsoft.Storage.Admin/preview/2019-08-08/storage.json#L169:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.Storage.Admin/preview/2019-08-08/storage.json#L169:5 |
️❌LintDiff: 3 Errors, 0 Warnings failed [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
| Rule | Message |
|---|---|
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Storage.Admin/preview/2019-08-08/storage.json#L202 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Storage.Admin/preview/2019-08-08/storage.json#L242 |
R4019 - GetCollectionResponseSchema |
The response in the GET collection operation 'StorageServices_ListRG' does not match the response definition in the individual GET operation 'StorageServices_Get' . Location: Microsoft.Storage.Admin/preview/2019-08-08/storage.json#L94 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 4 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"azsadmin/resource-manager/storage/readme.md", "tag":"package-2019-08-08", "details":"The schema 'Operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"azsadmin/resource-manager/storage/readme.md", "tag":"package-2019-08-08", "details":"The schema 'Display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"azsadmin/resource-manager/storage/readme.md", "tag":"package-2019-08-08", "details":"The schema 'OperationList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"azsadmin/resource-manager/storage/readme.md", "tag":"package-2019-08-08", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
Thank you for your contribution emontgomerydae! We will review the pull request and get back to you soon. |
|
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki [Window to Fix Broken]( Window to Fix Broken - Overview (azure.com)) for more details. |
|
This is a lot... just found a missing / is all |
|
Hi @emontgomerydae, 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. |
|
NewApiVersionRequired reason: |
|
Hi @emontgomerydae, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
This seems like death by CICD... I would assume this is just an issue in the documentation, not an actual change to the API itself |
|
I understand this PR is only adjusting for a typo in the path. The breaking change will not be blocking the merge. However, we continue to improve our validation logics that try to catch inconsistencies and ensure API consistencies. For the three linter errors:
I strongly recommend you take advantage of this month's Fix360 window to fix these little inconsistencies. If you chose not to, the next window may be some time away. |
|
@emontgomerydae, thank you for your contribution! |
Found a path with a missing /
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.