Correct swagger spec for error responses. #12317
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, @rkrishna12 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 Generation Artifacts
|
|
Hi @rkrishna12, 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. |
|
Hi @rkrishna12, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
@ChenTanyi, One thing to note - the service is returning the error response in the correct OpenAPI format but the swagger spec did not match this. This PR corrects the swagger spec to match the actual behavior, hence no API version change was done. |
PakDLiu
approved these changes
Jan 7, 2021
lagalbra
approved these changes
Jan 7, 2021
|
This API version has always been in Preview. Our RP in general is in Public Preview, and is not expected to become GA for at least 6 months to a year. |
|
@rkrishna12 You need to fix the CI error although it may not be caused by this PR. |
|
@ChenTanyi, to clarify - the "Swagger ModelValidation" errors need to be fixed in this same PR before presenting to the "Breaking change" review board and merging? |
|
Yes, you could also create a new PR only fix for the validation error, if there are no breaking changes. |
the correct casing.
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
most of HanaInstance properties.
lagalbra
approved these changes
Jan 8, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
properties. Must fix the example code.
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Jan 14, 2021
|
@ArcturusZhang Could you take a look at GO failure? |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
@ChenTanyi rerun and it should pass - there was a bug fixed a few hours ago |
This was referenced Jan 15, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Correct swagger spec for error responses. * Fix example file for SAP monitor create to use the correct casing. * Remove read-only setting from most of HanaInstance properties. * Fix remaining model validation failures. * One more property to fix * Resource object should have read-only properties. Must fix the example code. * Remove read-only properties from example file * Fix error from prettier
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.
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.
N/A, no new features.
Service is already in public preview.
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.