New ApiVersion 2022-09-01-preview : Fix Linter errors #23706
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, @solankisamir 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 Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| apimapis.json | 2022-09-01-preview(f441e75) | 2022-08-01(main) |
| apimapis.json | 2022-09-01-preview(f441e75) | 2022-04-01-preview(main) |
| apimpolicies.json | 2022-09-01-preview(f441e75) | 2022-08-01(main) |
| apimpolicies.json | 2022-09-01-preview(f441e75) | 2022-04-01-preview(main) |
| apimpolicyfragments.json | 2022-09-01-preview(f441e75) | 2022-08-01(main) |
| apimpolicyfragments.json | 2022-09-01-preview(f441e75) | 2022-04-01-preview(main) |
| apimportalconfigs.json | 2022-09-01-preview(f441e75) | 2022-08-01(main) |
| apimportalconfigs.json | 2022-09-01-preview(f441e75) | 2022-04-01-preview(main) |
| apimproducts.json | 2022-09-01-preview(f441e75) | 2022-08-01(main) |
| apimproducts.json | 2022-09-01-preview(f441e75) | 2022-04-01-preview(main) |
| definitions.json | 2022-09-01-preview(f441e75) | 2022-08-01(main) |
| definitions.json | 2022-09-01-preview(f441e75) | 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(f441e75) | 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 |
|---|---|
|
The response in the GET collection operation 'Api_ListByService' does not match the response definition in the individual GET operation 'Api_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L37 |
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L215 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L313 |
|
The response in the GET collection operation 'ApiRelease_ListByService' does not match the response definition in the individual GET operation 'ApiRelease_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L523 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L705 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L787 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L787 |
|
The response in the GET collection operation 'ApiOperation_ListByApi' does not match the response definition in the individual GET operation 'ApiOperation_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L877 |
|
The response in the GET collection operation 'ApiOperationPolicy_ListByOperation' does not match the response definition in the individual GET operation 'ApiOperationPolicy_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L1241 |
|
The response in the GET collection operation 'Tag_ListByOperation' does not match the response definition in the individual GET operation 'Tag_GetByOperation' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L1532 |
|
The response in the GET collection operation 'GraphQLApiResolver_ListByApi' does not match the response definition in the individual GET operation 'GraphQLApiResolver_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L1810 |
|
The response in the GET collection operation 'GraphQLApiResolverPolicy_ListByResolver' does not match the response definition in the individual GET operation 'GraphQLApiResolverPolicy_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L2164 |
|
The response in the GET collection operation 'ApiPolicy_ListByApi' does not match the response definition in the individual GET operation 'ApiPolicy_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L2520 |
|
The response in the GET collection operation 'ApiSchema_ListByApi' does not match the response definition in the individual GET operation 'ApiSchema_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L2804 |
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L2967 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3011 |
|
A 202 response should include an Location response header. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3011 |
|
The response in the GET collection operation 'ApiDiagnostic_ListByService' does not match the response definition in the individual GET operation 'ApiDiagnostic_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3107 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3371 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3371 |
|
The response in the GET collection operation 'ApiIssue_ListByService' does not match the response definition in the individual GET operation 'ApiIssue_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3461 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3657 |
|
The response in the GET collection operation 'ApiIssueComment_ListByService' does not match the response definition in the individual GET operation 'ApiIssueComment_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3829 |
|
The response in the GET collection operation 'ApiIssueAttachment_ListByService' does not match the response definition in the individual GET operation 'ApiIssueAttachment_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L4134 |
|
The response in the GET collection operation 'ApiTagDescription_ListByService' does not match the response definition in the individual GET operation 'ApiTagDescription_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L4439 |
|
The response in the GET collection operation 'Tag_ListByApi' does not match the response definition in the individual GET operation 'Tag_GetByApi' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L4729 |
|
The response in the GET collection operation 'ApiWikis_List' does not match the response definition in the individual GET operation 'ApiWiki_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L5350 |
|
The response in the GET collection operation 'Policy_ListByService' does not match the response definition in the individual GET operation 'Policy_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimpolicies.json#L37 |
|
The response in the GET collection operation 'PolicyFragment_ListByService' does not match the response definition in the individual GET operation 'PolicyFragment_Get' . Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimpolicyfragments.json#L37 |
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimpolicyfragments.json#L204 |
️️✔️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
|
Generated ApiView
|
ghost
added
the
solankisamir
changed the title
11 tasks
|
Fixing linter errors identified here - #22978 |
live1206
approved these changes
Apr 26, 2023
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 <[email protected]> * 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 <[email protected]> Co-authored-by: promoisha <[email protected]> Co-authored-by: promoisha <[email protected]>
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.
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.