Release api management 2022 08 01 #21169
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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| apimanagement.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimanagement.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimapis.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimapis.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimapisByTags.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimapisByTags.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimapiversionsets.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimapiversionsets.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimauthorizationproviders.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimauthorizationservers.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimauthorizationservers.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimbackends.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimbackends.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimcaches.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimcaches.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimcertificates.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimcertificates.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimconnectivitycheck.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimconnectivitycheck.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimcontenttypes.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimcontenttypes.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimdeletedservices.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimdeletedservices.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimdeployment.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimdeployment.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimdiagnostics.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimdiagnostics.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimemailtemplates.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimemailtemplates.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimgateways.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimgateways.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimgroups.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimgroups.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimidentityprovider.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimidentityprovider.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimissues.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimissues.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimloggers.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimloggers.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimnamedvalues.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimnamedvalues.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimnetworkstatus.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimnetworkstatus.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimnotifications.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimnotifications.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimopenidconnectproviders.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimopenidconnectproviders.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimoutbounddependency.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimoutbounddependency.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimpolicies.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimpolicies.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimpolicydescriptions.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimpolicydescriptions.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimpolicyfragments.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimportalconfigs.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimportalrevisions.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimportalrevisions.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimportalsettings.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimportalsettings.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimprivatelink.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimprivatelink.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimproducts.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimproducts.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimproductsByTags.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimproductsByTags.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimquotas.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimquotas.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimregions.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimregions.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimreports.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimreports.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimschema.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimschema.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimsettings.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimsettings.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimskus.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimskus.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimsubscriptions.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimsubscriptions.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimtagresources.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimtagresources.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimtags.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimtags.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimtenant.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimtenant.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| apimusers.json | 2022-08-01(985c456) | 2021-08-01(main) |
| apimusers.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
| definitions.json | 2022-08-01(985c456) | 2021-08-01(main) |
| definitions.json | 2022-08-01(985c456) | 2022-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 11 items are listed, please refer to log for more details.
️⚠️LintDiff: 35 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08 | package-2022-08(985c456) | default(release-apimangement-2022-08-01) |
[must fix]The following errors/warnings are introduced by current PR:
Only 11 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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 |
||
| 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 |
||
| OperationId should contain the verb: 'getloginlinks' in:'AuthorizationLoginLinks_Post'. Consider updating the operationId Location: Microsoft.ApiManagement/stable/2022-08-01/apimauthorizationproviders.json#L527 |
||
| The child tracked resource, 'authorizations' with immediate parent 'AuthorizationProviderContract', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1174 |
||
| The child tracked resource, 'accessPolicies' with immediate parent 'AuthorizationContract', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1291 |
||
| The child tracked resource, 'authorizationProviders' with immediate parent 'ApiManagementServiceResource', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1363 |
||
| The child tracked resource, 'policyFragments' with immediate parent 'ApiManagementServiceResource', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L4344 |
||
| The child tracked resource, 'portalconfigs' with immediate parent 'ApiManagementServiceResource', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L4444 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: useInTestConsole Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1589 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: useInApiDocumentation Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1593 |
The following errors/warnings exist before current PR submission:
Only 11 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L972 |
|
The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L37 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L38 |
️⚠️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 |
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
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. |
rkmanda
reviewed
Oct 21, 2022
.../apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json
Show resolved
Hide resolved
rkmanda
reviewed
Oct 21, 2022
.../apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json
Show resolved
Hide resolved
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
|
Breaking Change Investigation:
|
"change from Resource to ProxyResource" likely breaks SDK. @tadelesh @msyyc @qiaozha @ArthurMa1978 If any of you having problem with it. |
Resolved Go breakings by directive. |
|
Hi @solankisamir, Your PR has some issues. Please fix the CI sequentially by following the order of
|
weidongxu-microsoft
approved these changes
Oct 26, 2022
|
please fix ModelValidation |
11 tasks
|
|
ping me when you ready to merge |
11 tasks
11 tasks
lirenhe
pushed a commit
that referenced
this pull request
Feb 14, 2023
* Release api management 2022 08 01 (#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 (#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 (#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 (#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 (#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>
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.