updated ErrorResponse in DataExport and OperationStatuses #13012
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, @dabenhamMic 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
Only 10 items are listed, please refer to log for more details.
|
| Rule | Message |
|---|---|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get specific operation status Location: Microsoft.OperationalInsights/stable/2020-10-01/Operations.json#L39 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/operationalinsights/resource-manager/readme.md tag: specification/operationalinsights/resource-manager/readme.md#tag-package-2020-10 |
️️✔️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: 143 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DataExport' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DataExportListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DataExportProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'Destination' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DestinationMetaData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DataSource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DataSourceFilter' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'DataSourceListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'IntelligencePack' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"operationalinsights/resource-manager/readme.md", "tag":"package-2020-10", "details":"The schema 'LinkedServiceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @dabenhamMic, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
BreakingChangeReviewRequired
and removed
CI-FixRequiredOnFailure
labels
|
Hi @dabenhamMic, 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. |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
This was referenced Feb 17, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
CI-BreakingChange-Go
and removed
CI-FixRequiredOnFailure
labels
|
@markcowl we have changed the contract from custom definition error response to common ErrorResponse. |
|
@dabenhamMic Was this done in response to an s360 issue on swagger correctness or completeness? If so, link it here, and we may be able to approve without the breaking chaneg review. Otherwise, breaking change review is required, even for 'good' changes. 'good' changes may be approved. |
25 tasks
|
Hi @akning-ms could you help on this breaking change warning? This PR only replace the self-defined error model with the error model defined in common-types, which is not really a breaking change, I suppose. |
Yes. looks a false alarm. it is due to a extra type: object in old version. + @jianyexi for awareness |
Agreed, this change has no impact, can be approved safely. |
|
@jianyexi Change from a locally defined schema to the common schema automatically changes types in any strongly typed language SDK. This may have been done for good reason, but it is a breaking change in the api definition |
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Feb 23, 2021
This was referenced Feb 23, 2021
Since the autorest modeler4 can auto-corrected the undefined type to "'type:object'" , and the model name and its definition are not changed, why there are breaking change ? The SDK generation even don't know this change 's happen . |
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* updated ErrorResponse in DataExport and OperationStatuses * removed whitespace * fixed ErrorResponse in Cluster 2020-08-01 * ErrorResponse in Tables.json 2020-08-01 * changed min retention of TablesList to 30 from 7
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.
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.