-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Adding Resolver Entities to documentation #21352
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding Resolver Entities to documentation #21352
Conversation
* 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
|
Hi, @hoonality 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] |
|
Hi, @hoonality your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| apimanagement.json | 2022-08-01(d087fe2) | 2021-08-01(main) |
| apimanagement.json | 2022-08-01(d087fe2) | 2022-04-01-preview(main) |
| apimapis.json | 2022-08-01(d087fe2) | 2021-08-01(main) |
| apimapis.json | 2022-08-01(d087fe2) | 2022-04-01-preview(main) |
| definitions.json | 2022-08-01(d087fe2) | 2021-08-01(main) |
| definitions.json | 2022-08-01(d087fe2) | 2022-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08 | package-2022-08(d087fe2) | package-2022-08(release-apimangement-2022-08-01) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The child tracked resource, 'policies' with immediate parent 'ResolverContract', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L4214 |
||
| The child tracked resource, 'resolvers' with immediate parent 'ApiContract', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5632 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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 @hoonality, 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. |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
| "$ref": "./examples/ApiManagementHeadGraphQLApiResolver.json" | ||
| } | ||
| }, | ||
| "parameters": [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hoonality I see the target branch here is Azure:release-apimangement-2022-08-01 - is that a development branch, and this is a new API in development that is not deployed yet?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep @TimLovellSmith, https://github.com/Azure/azure-rest-api-specs/tree/release-apimangement-2022-08-01 has updates for api management in development, and this PR includes new resources being added that are not yet deployed.
Thanks!
cc: @solankisamir
|
Breaking changes justification: I believe the breaking changes are related to similar issues seen during the base branch PR merged: The reason for the breaking changes were stated in that PR for the release-apimanagement-2022-08-01 branch: Let me know if I may have missed anything, thanks! |
|
@honghr please review the PR and merge if it meets all the criterion. Thanks! |
* 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: hoonality <[email protected]> Co-authored-by: malincrist <[email protected]> Co-authored-by: changlong-liu <[email protected]> Co-authored-by: Logan Zipkes <[email protected]>
* 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: hoonality <[email protected]> Co-authored-by: malincrist <[email protected]> Co-authored-by: changlong-liu <[email protected]> Co-authored-by: Logan Zipkes <[email protected]>
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.
Added Notes
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.