Skip to content
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.

Sign up for GitHub

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

Jump to bottom

wiki for apis and products #21595

Merged
merged 16 commits into from
Jan 26, 2023
Merged

wiki for apis and products #21595

merged 16 commits into from
Jan 26, 2023

Conversation

malincrist
Copy link
Member

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify - Added new things to a new API version.
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

@openapi-workflow-bot
Copy link

Hi, @malincrist Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 17, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 18 Errors, 207 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    apimanagement.json 2022-08-01(e2b8e7d) 2021-08-01(main)
    apimanagement.json 2022-08-01(e2b8e7d) 2022-04-01-preview(main)
    apimapis.json 2022-08-01(e2b8e7d) 2021-08-01(main)
    apimapis.json 2022-08-01(e2b8e7d) 2022-04-01-preview(main)
    apimproducts.json 2022-08-01(e2b8e7d) 2021-08-01(main)
    apimproducts.json 2022-08-01(e2b8e7d) 2022-04-01-preview(main)
    definitions.json 2022-08-01(e2b8e7d) 2021-08-01(main)
    definitions.json 2022-08-01(e2b8e7d) 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.

    Rule Message
    ❌ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ApiVersionParameter' removed or renamed?
    New: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L132:3
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L132:3
    ❌ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupNameParameter' removed or renamed?
    New: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L132:3
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L132:3
    ❌ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'SubscriptionIdParameter' removed or renamed?
    New: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L132:3
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L132:3
    ❌ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5966:7
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L5073:7
    ❌ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5966:7
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L5073:7
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L262:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L67:9
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L267:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L71:9
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L262:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L40:9
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L267:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L44:9
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L272:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L48:9
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L277:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L75:9
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'document' that was not found in the old version.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5952:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L5059:9
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'document' that was not found in the old version.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5965:5
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L5072:5
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'document' that was not found in the old version.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5952:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L5059:9
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'document' that was not found in the old version.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L5965:5
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L5072:5
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1005:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L936:9
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1005:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L936:9
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1005:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L936:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: common-types/resource-management/v3/types.json#L305:9
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L57:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: common-types/resource-management/v3/types.json#L280:11
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L77:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L217:11
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L217:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L197:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L197:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L318:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L309:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L303:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L294:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L383:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L374:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L692:11
    Old: Microsoft.ApiManagement/stable/2021-08-01/definitions.json#L623:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L663:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L654:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L709:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L700:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L739:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L730:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L727:13
    Old: Microsoft.ApiManagement/stable/2021-08-01/apimapis.json#L718:13


    The following breaking changes are detected by comparison with the latest preview version:

    Rule Message
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: common-types/resource-management/v3/types.json#L305:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L57:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: common-types/resource-management/v3/types.json#L280:11
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L77:11
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L262:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L67:9
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L267:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L71:9
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L262:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L40:9
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L267:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L44:9
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L272:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L48:9
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L277:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/apimanagement.json#L75:9
    ️❌LintDiff: 3 Errors, 3 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2022-08 package-2022-08(e2b8e7d) 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]
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ApiManagementGetApiWiki
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L5351
    ⚠️ ListInOperationName 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
    ⚠️ GetInOperationName '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


    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ 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
    ❌ MissingTypeObject The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L55
    ❌ MissingTypeObject The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L65
    ❌ MissingTypeObject The schema 'RegionContract' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L89
    ❌ MissingTypeObject The schema 'RegionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L107
    ❌ GetCollectionResponseSchema 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
    ❌ CreateOperationAsyncResponseValidation 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
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L313
    ❌ LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L313
    ❌ GetCollectionResponseSchema 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
    ❌ RepeatedPathInfo 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
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L781
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L781
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ❌ CreateOperationAsyncResponseValidation 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
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3005
    ❌ LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3005
    ❌ GetCollectionResponseSchema 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
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3365
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L3365
    ❌ GetCollectionResponseSchema 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
    ❌ RepeatedPathInfo 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
    ❌ GetCollectionResponseSchema 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
    ❌ GetCollectionResponseSchema 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
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️~[Staging] CadlAPIView 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.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 17, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️🔄ApiDocPreview inProgress [Detail]
    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-go failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-python-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-resource-manager-schemas warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-powershell failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 17, 2022 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    JavaScript @azure/arm-apimanagement https://apiview.dev/Assemblies/Review/6c82b95507dd462da47fe837e5932932

    @ghost ghost added the API Management label Nov 17, 2022
    This was referenced Nov 17, 2022
    Draft
    Closed
    Closed
    @changlong-liu
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @malincrist @changlong-liu
    Updated path
    9f5938e 
    Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com>
    @azure-sdk azure-sdk mentioned this pull request Nov 29, 2022
    Closed
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 29, 2022
    @openapi-workflow-bot
    Copy link

    Hi @malincrist, 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.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot
    Copy link

    Hi @malincrist, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
     If you need further help, please feedback via swagger feedback.

    This was referenced Nov 29, 2022
    Closed
    Closed
    Draft
    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Dec 28, 2022
    @mentat9
    Copy link
    Member

    mentat9 commented Jan 7, 2023

    @malincrist - I added a couple of comments, plus there are a couple of questions/comments remaining from @visingla-ms that you haven't responded to. Note, this PR was not on ARM review radar because you didn't remove the ARMChangesRequested label. That's how we know to revisit your PR. Please remove that label to respond, per this comment: #21595 (comment).

    @solankisamir
    Copy link
    Member

    {

    This swagger version was also added to private Repo and reviewed?

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json:1 in 9f5938e. [](commit_id = 9f5938e, deletion_comment = False)

    @visingla-ms we have not reviewed the PR in private repo.

    @malincrist malincrist removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 17, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 17, 2023
    raosuhas
    raosuhas reviewed Jan 18, 2023
    View reviewed changes
    ...ation/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimapis.json
    @@ -4415,6 +4415,332 @@
    },
    "x-ms-odata": "./definitions.json#/definitions/TagResourceContract"
    }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default": {
    "head": {
    Copy link

    @raosuhas raosuhas Jan 18, 2023 •
    edited
    Loading

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    head

    I dont think ARM supports the HEAD method. Why do you need this for ? #Resolved

    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    We have HEAD method for most of our specifications. It is used to set the ETag header.

    Copy link

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Looks like I was mistaken , there are a couple of other RPs using HEAD as well. Thanks.

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 18, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 18, 2023
    @malincrist malincrist removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 19, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 19, 2023
    @solankisamir solankisamir added the 2022-08-01 APIM 2022-08-01 PRs label Jan 20, 2023
    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 20, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 20, 2023
    @solankisamir
    Copy link
    Member

    @changlong-liu can you please look into this PR and merge this, if things look okay?

    @leni-msft leni-msft merged commit af12c7f into Azure:release-apimangement-2022-08-01 Jan 26, 2023
    @solankisamir solankisamir mentioned this pull request Feb 3, 2023
    Merged
    11 tasks
    lirenhe pushed a commit that referenced this pull request Feb 14, 2023
    @solankisamir @tadelesh
    @hoonality @malincrist @changlong-liu @LFZ96
    Release apimangement 2022-08 01 (#22313)
    2f17a90 
    * 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
    @solankisamir @tadelesh
    @hoonality @malincrist @changlong-liu @LFZ96 @aviyerMSFT
    Release apimangement 2022-08 01 (Azure#22313)
    4a59ba6 
    * 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
    Reviewers

    @raosuhas raosuhas raosuhas left review comments

    @mentat9 mentat9 mentat9 left review comments

    @changlong-liu changlong-liu changlong-liu left review comments

    @visingla-ms visingla-ms visingla-ms left review comments

    @solankisamir solankisamir solankisamir approved these changes

    @ruowan ruowan ruowan approved these changes

    Assignees

    @changlong-liu changlong-liu

    Labels
    2022-08-01 APIM 2022-08-01 PRs API Management Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-JavaScript CI-FixRequiredOnFailure resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    10 participants
    @malincrist @changlong-liu @visingla-ms @mentat9 @solankisamir @raosuhas @ruowan @leni-msft @AzureRestAPISpecReview @mikekistler