Release apimangement 2022-08 01 #22313
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
* add base for 2022-08-01 * updates readme.md * update api-version and examples * resolve Go SDK breaking change * update examples to fix model definition Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn>
* merging in resolver entities * adding resolver updates * fixed policy examples that were missing a policyId param * fixed typo that added a nested properties prop * fixed description for API Resolvers List, filter query * fixed error in definitions for resolvers * fixed example that had an incorrect response definition * added missing json file references * fix for linting errors * ref fixes and undoing bad merge overwrites * fix typo
|
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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-08 | package-2022-08(7008bab) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
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/stable/2022-08-01/apimapis.json#L1804 |
|
|
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/stable/2022-08-01/apimapis.json#L2158 |
|
|
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/stable/2022-08-01/apimapis.json#L5344 |
|
|
The response in the GET collection operation 'AuthorizationProvider_ListByService' does not match the response definition in the individual GET operation 'AuthorizationProvider_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationproviders.json#L37 |
|
|
The response in the GET collection operation 'Authorization_ListByAuthorizationProvider' does not match the response definition in the individual GET operation 'Authorization_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationproviders.json#L275 |
|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Authorization' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationproviders.json#L280 |
|
|
The response in the GET collection operation 'AuthorizationAccessPolicy_ListByAuthorization' does not match the response definition in the individual GET operation 'AuthorizationAccessPolicy_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationproviders.json#L645 |
|
|
The response in the GET collection operation 'Documentation_ListByService' does not match the response definition in the individual GET operation 'Documentation_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimdocumentations.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/stable/2022-08-01/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/stable/2022-08-01/apimpolicyfragments.json#L201 |
RPC-Async-V1-01 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.ApiManagement/stable/2022-08-01/apimpolicyfragments.json#L266 |
RPC-Async-V1-01 |
|
The response in the GET collection operation 'PortalConfig_ListByService' does not match the response definition in the individual GET operation 'PortalConfig_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L37 |
|
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L205 |
RPC-Patch-V1-02 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L205 |
RPC-Patch-V1-02 |
|
The response in the GET collection operation 'ProductWikis_list' does not match the response definition in the individual GET operation 'ProductWiki_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimproducts.json#L1682 |
|
|
'items.type' property must be truthy Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L4603 |
|
| OperationId should contain the verb: 'getloginlinks' in:'AuthorizationLoginLinks_Post'. Consider updating the operationId Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationproviders.json#L527 |
||
| Based on the response model schema, operation 'PolicyFragment_ListByService' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ApiManagement/stable/2022-08-01/apimpolicyfragments.json#L38 |
||
| Based on the response model schema, operation 'PortalConfig_ListByService' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L38 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L49 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L91 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L137 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L186 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.ApiManagement/stable/2022-08-01/apimportalconfigs.json#L241 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimproducts.json#L1683 |
||
| 'GET' operation 'ProductWikis_list' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ApiManagement/stable/2022-08-01/apimproducts.json#L1687 |
||
| 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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/definitions.json#L1784 |
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/stable/2022-08-01/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/stable/2022-08-01/apimapis.json#L215 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L313 |
|
A 202 response should include an Location response header. Location: Microsoft.ApiManagement/stable/2022-08-01/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/stable/2022-08-01/apimapis.json#L517 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L699 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L781 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L781 |
|
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/stable/2022-08-01/apimapis.json#L871 |
|
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/stable/2022-08-01/apimapis.json#L1235 |
|
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/stable/2022-08-01/apimapis.json#L1526 |
|
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/stable/2022-08-01/apimapis.json#L2514 |
|
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/stable/2022-08-01/apimapis.json#L2798 |
|
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/stable/2022-08-01/apimapis.json#L2961 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3005 |
|
A 202 response should include an Location response header. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3005 |
|
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/stable/2022-08-01/apimapis.json#L3101 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3365 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3365 |
|
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/stable/2022-08-01/apimapis.json#L3455 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3651 |
|
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/stable/2022-08-01/apimapis.json#L3823 |
|
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/stable/2022-08-01/apimapis.json#L4128 |
|
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/stable/2022-08-01/apimapis.json#L4433 |
|
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/stable/2022-08-01/apimapis.json#L4723 |
|
The response in the GET collection operation 'ApiVersionSet_ListByService' does not match the response definition in the individual GET operation 'ApiVersionSet_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimapiversionsets.json#L37 |
|
The response in the GET collection operation 'AuthorizationServer_ListByService' does not match the response definition in the individual GET operation 'AuthorizationServer_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationservers.json#L37 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationservers.json#L286 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationservers.json#L286 |
|
The response in the GET collection operation 'Backend_ListByService' does not match the response definition in the individual GET operation 'Backend_Get' . Location: Microsoft.ApiManagement/stable/2022-08-01/apimbackends.json#L37 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/apimanagement/resource-manager/readme.md json: Microsoft.ApiManagement/stable/2022-08-01/definitions.json |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.ApiManagement' for api version '2022-08-01'. The supported api-versions are '2014-02-14, 2015-09-15, 2016-07-07, 2016-10-10, 2017-03-01, 2018-01-01, 2018-06-01-preview, 2019-01-01, 2019-12-01-preview, 2019-12-01, 2020-06-01-preview, 2020-12-01, 2021-01-01-preview, 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
solankisamir
requested review from
adrianhall,
LFZ96 and
malincrist
and removed request for
ArcturusZhang
This was referenced Jan 25, 2023
Closed
AzureRestAPISpecReview
added
ARMReview
BreakingChangeReviewRequired
|
Hi @solankisamir, 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 @solankisamir, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @solankisamir, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
About Lint diff, |
|
@zzvswxy arm team also signed off |
|
Hi @solankisamir I talk with SDK owners and LintDiff check maintainer. Their requirement are list in the comment above. They both consider the issues need to be fixed.
So can you fix the issues go SDK owner said:
Other issues can fix in next API version. |
About how to fix: This error cause both .NET/Go/Python SDK generation failed. So the SDK owners think it's necessary to fix the |
Ok found the issue with duplicate schema and fixed that error in the pr #22537 |
* linter errors * prettier * v2 * fix error response duplicate schema * type object * prettier * sync data from current ga version * remove duplicate parameter * type object
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
@zzvswxy how does it look after the merge? Can we merge to main branch? |
lirenhe
approved these changes
Feb 14, 2023
This was referenced Feb 14, 2023
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Feb 14, 2023
11 tasks
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* Release api management 2022 08 01 (Azure#21169) * add base for 2022-08-01 * updates readme.md * update api-version and examples * resolve Go SDK breaking change * update examples to fix model definition Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn> * Adding Resolver Entities to documentation (Azure#21352) * merging in resolver entities * adding resolver updates * fixed policy examples that were missing a policyId param * fixed typo that added a nested properties prop * fixed description for API Resolvers List, filter query * fixed error in definitions for resolvers * fixed example that had an incorrect response definition * added missing json file references * fix for linting errors * ref fixes and undoing bad merge overwrites * fix typo * wiki for apis and products (Azure#21595) * wiki for apis and products * prettier; fixed spellchecks * Fixed spelling * Updated path Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> * code review changes; gihub checks fixes * fixed conact name and paths * added properties back * added contract properties objects * fixed lint * changed example to match the definition * prettier * code review changes * added paths and examples for wiki collections * Added x-ms-pageable * removed count Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> * Add ConfirmConsentCode to APIM RP (Azure#22418) * Update apimauthorizationproviders.json Add ConfirmConsentCode endpoint * Update definitions.json * Create ApiManagementPostAuthorizationConfirmConsentCodeRequest.json * Update definitions.json Remove count property * Update apimauthorizationproviders.json * [2022-08-01] Fix Linter Errors (Azure#22537) * linter errors * prettier * v2 * fix error response duplicate schema * type object * prettier * sync data from current ga version * remove duplicate parameter * type object --------- Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn> Co-authored-by: hoonality <92482069+hoonality@users.noreply.github.com> Co-authored-by: malincrist <92857141+malincrist@users.noreply.github.com> Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Co-authored-by: Logan Zipkes <44794089+LFZ96@users.noreply.github.com>
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.