Fix ARM Errors and update the swagger files. #12293
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
|
Hi, @ericshape 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 Generation Artifacts
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @ericshape your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ |
|
NewApiVersionRequired reason: |
|
Hi @ericshape, 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 Jan 5, 2021
eswatad
approved these changes
Jan 5, 2021
|
Notes about the breaking change:
In addition, @sredman and @hotsnr have approved this public API spec Pull request.
|
|
We also added ServerDevOpsAudit spec and example files to 2020-02-02 folder. They are some missing files which are expected to add last month. This change has been approved by the owner @eswatad |
sredman
approved these changes
Jan 5, 2021
hotsnr
approved these changes
Jan 5, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
Hi @ericshape, Your PR has some issues. Please fix the CI sequentially by following the order of
|
filizt
reviewed
Jan 6, 2021
| @@ -88,7 +88,7 @@ | |||
| } | |||
| }, | |||
| "default": { | |||
There was a problem hiding this comment.
"default": { [](start = 10, length = 12)
Ideally the "default" response should have an associated schema. Not for this PR, but in a separte PR I'd recommend adding a schema definition for default response in the APIs that don't have the definition(I see there are many).
There was a problem hiding this comment.
@filizt Thanks for your suggestions!
do we have ARM/API/SDK rules to enforce it? All these spec and example files are auto-generated by SQL DB repo. And this issue was not mentioned by any reviewer in recent previous PRs.
There was a problem hiding this comment.
Hi @ericshape , actually we have ARM Lint rule for this: https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r4007-defaulterrorresponseschema
But currently to keep your service consistent and breaking change consideration, this Rule is only for new Service, guess why Filizt said ideally. :)
There was a problem hiding this comment.
Thanks for your comments, Arthur!
It seems the static validation service is mandatory for SQL DB repo. It will enforce these rules on Day one and reduce the engineer efforts on both ARM/API/SDK and SQL DB sides.
lint diff is addressed. |
akning-ms
reviewed
Jan 12, 2021
| "ImportExport" | ||
| ], | ||
| "description": "Imports a bacpac into a new database.", | ||
| "operationId": "Databases_Import", |
There was a problem hiding this comment.
I think the previous operation id should be: ImportExport_Import, right?
There was a problem hiding this comment.
I have replied your message in the internal group chat.
There was a problem hiding this comment.
due to the complexity of the change. I will remove import export from this PR and you can merge it.
Then I will create a new PR to address the import/export rollback issue.
|
From ARM side, this PR seems ready I just left one additional comment regarding your /default endpoint. |
@jorgearteiro thanks for your review! we will improve the swagger generation to address the issue you mentioned soon. |
…specs into fix_arm_errors
25 tasks
akning-ms
removed
the
WaitForARMFeedback
|
as ARM reviewed in PR#10994 for new adding API ServerDevopsAudit.json and this PR is adding missing api in a old version. so removed ARM review label here, and merged this PR |
This was referenced Jan 14, 2021
Closed
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jan 14, 2021
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.
Fix some ARM Errors and update the swagger files.
The error list is here: https://github.com/Azure/azure-rest-api-specs/pull/12107/checks?check_run_id=1594037578
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 API Review Board as defined in the Breaking Change Policy.
I have provided a detailed explanation of breaking changes in the thread.
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.