Add circuit breaker to the backend contract (#21320)#23359
Merged
live1206 merged 1 commit intoAzure:release-apimanagement-2022-09-01-previewfrom Apr 3, 2023
Merged
Conversation
* add circuit breaker to the backend contract * resolve validation errors * Revert "resolve validation errors" and last push This reverts commit c557685. * resolve validation errors * run prettier
|
Hi, @m-h-s 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| definitions.json | 2022-09-01-preview(8b75149) | 2022-08-01(main) |
| definitions.json | 2022-09-01-preview(8b75149) | 2022-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-09 | package-preview-2022-09(8b75149) | package-preview-2022-09(release-apimanagement-2022-09-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
'items.type' property must be truthy Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L4701 |
|
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L7683 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L7686 |
|
The schema 'ContentItemContractProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L7803 |
|
Property name should be camel case. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L8125 |
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L89 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L115 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L148 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L169 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L575 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L579 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L598 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L837 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L842 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1625 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1677 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1681 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1780 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1784 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1912 |
|
| For better generated code quality, remove all references to 'msdn.microsoft.com'. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2074 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2175 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2180 |
|
| Schema should have a description or title. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2566 |
|
| Schema should have a description or title. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2587 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2636 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2720 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2800 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L2870 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L3026 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
This was referenced Mar 29, 2023
solankisamir
approved these changes
Mar 29, 2023
Member
|
@live1206 can you please take a look at this small PR? |
weidongxu-microsoft
pushed a commit
that referenced
this pull request
Apr 28, 2023
* Adds base for updating Microsoft.ApiManagement from version stable/2022-08-01 to version 2022-09-01-preview * Updates readme * Updates API version in new specs and examples * Add circuit breaker to the backend contract (#21320) (#23359) * add circuit breaker to the backend contract * resolve validation errors * Revert "resolve validation errors" and last push This reverts commit c557685. * resolve validation errors * run prettier * stv2.1 (#23326) * added Workspaces feature-related endpoints and contracts (#23330) * added Workspaces feature-related endpoints and contracts * cleanup * prettier * + examples * - redundant examples * link contracts for PUT * typo * Location header added to async operations --------- Co-authored-by: promoisha <glfeokti@microsoft.com> * New ApiVersion 2022-09-01-preview : Fix Linter errors (#23706) * x-ms-pageable extension for all list calls on policy * x-ms-secret to secret values * location header and invalid produces * New Api-Version 2022-09-01-preview: Linter Errors (#23739) * boolean to x-ms-enum * add location header to 202 response * Location header to all 202 operations --------- Co-authored-by: Mahsa Sadi <mahsa.sadi@utoronto.ca> Co-authored-by: promoisha <feoktistovgg@gmail.com> Co-authored-by: promoisha <glfeokti@microsoft.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.