[Hub Generated] Review request for Microsoft.AzureStack to add version stable/2017-06-01 #11937
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
Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
|
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/_all/GetProducts' removed or restructured? Old: Microsoft.AzureStack/stable/2017-06-01/Product.json#L147:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/GetProduct' removed or restructured? Old: Microsoft.AzureStack/stable/2017-06-01/Product.json#L192:5 |
|
The new version adds a response code 'default'. New: Microsoft.AzureStack/stable/2017-06-01/AzureStack.json#L42:11 |
|
The new version adds a response code 'default'. New: Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json#L142:11 |
|
The new version adds a response code 'default'. New: Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json#L188:11 |
|
The new version adds a response code 'default'. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L144:11 |
|
The new version adds a response code 'default'. New: Microsoft.AzureStack/stable/2017-06-01/Registration.json#L182:11 |
|
The new version adds a response code 'default'. New: Microsoft.AzureStack/stable/2017-06-01/Registration.json#L267:11 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L153:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L201:5 |
️⚠️LintDiff: 5 Warnings warning [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 |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L164 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L212 |
|
| Since operation 'Products_GetProducts' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L164 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns a list of products. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L155 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns the specified product. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L203 |
️️✔️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.
Swagger Generation Artifacts
|
|
Hi, @ionuttulai 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 |
AndyTao0402
approved these changes
Dec 4, 2020
|
NewApiVersionRequired reason: |
|
Hi @ionuttulai, 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. |
This was referenced Dec 4, 2020
@ionuttulai , please follow above action for breaking change review and also fix the other CI check failures. |
raych1
added
the
Reviewed-ChangesRequested
|
I think none of the PR changes are breaking changes. There are two actions that got renamed from "GetProduct" to "getProduct" to comply with Swagger linting rules for camelCase URLs, and some "default" response sections added where they're missing - also to address linting issues. @raych1 the automatic validation finds new paths for camelCase ones and removed for non-camelCase, when in fact they are the same URLs. |
@ionuttulai , changing case of URL segment is breaking change per the document. Please follow the process to request approval. |
|
We will be starting the process for introducing breaking changes. Thank you! |
|
Since this PR addresses only swagger correctness issues in s360 we would like to get it approved with breaking changes in the existing open window (until Jan 31st) according to this documentation: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/405/Window-to-Fix-Broken |
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Jan 20, 2021
|
@ionuttulai , can you update example file to fix |
|
Hi @ionuttulai, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-BreakingChange-Go
and removed
CI-FixRequiredOnFailure
labels
|
@raych1 I've updated the examples and fixed the remaining linting and completeness issues. |
This was referenced Jan 21, 2021
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jan 21, 2021
…zureStack to add version stable/2017-06-01 (#1473) Create to sync Azure/azure-rest-api-specs#11937 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/master...AzureSDKAutomation:sdkAuto/azurestack?expand=1)
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…n stable/2017-06-01 (Azure#11937) * added default error response where missing and fixed camel case action names * removed readonly properties from examples * removed more readonly properties from examples * remove hard-coded product name from swagger action * added enable remote management action * ran npm prettier on new jsong files * moved remote management action to registrations
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.
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 API 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.