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

Release apimanagement 2022 09 01 preview #22978

Merged
merged 8 commits into from
Apr 28, 2023
Merged

Release apimanagement 2022 09 01 preview #22978

merged 8 commits into from
Apr 28, 2023

Conversation

solankisamir
Copy link
Member

@solankisamir solankisamir commented Mar 9, 2023 •
edited
Loading

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
  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, @solankisamir 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 Mar 9, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️🔄Breaking Change(Cross-Version) inProgress [Detail]
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️❌LintDiff: 48 Errors, 13 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2022-09 package-preview-2022-09(b9e6dd2) 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]
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'ProductApiLink_ListByProduct' does not match the response definition in the individual GET operation 'ProductApiLink_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L1753
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'ProductGroupLink_ListByProduct' does not match the response definition in the individual GET operation 'ProductGroupLink_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L1976
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'TagApiLink_ListByProduct' does not match the response definition in the individual GET operation 'TagApiLink_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimtags.json#L380
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'TagOperationLink_ListByProduct' does not match the response definition in the individual GET operation 'TagOperationLink_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimtags.json#L603
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'TagProductLink_ListByProduct' does not match the response definition in the individual GET operation 'TagProductLink_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimtags.json#L826
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'Workspace_ListByService' does not match the response definition in the individual GET operation 'Workspace_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L37
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L286    		 RPC-Patch-V1-02
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L286    		 RPC-Patch-V1-02
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspacePolicy_ListByApi' does not match the response definition in the individual GET operation 'WorkspacePolicy_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L373
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceNamedValue_ListByService' does not match the response definition in the individual GET operation 'WorkspaceNamedValue_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L655
    ❌ 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/preview/2022-09-01-preview/apimworkspaces.json#L850    		 RPC-Async-V1-01
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L897    		 RPC-Async-V1-01
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceGlobalSchema_ListByService' does not match the response definition in the individual GET operation 'WorkspaceGlobalSchema_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1189
    ❌ 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/preview/2022-09-01-preview/apimworkspaces.json#L1356    		 RPC-Async-V1-01
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1424    		 RPC-Async-V1-01
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceNotification_ListByService' does not match the response definition in the individual GET operation 'WorkspaceNotification_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1495
    ❌ ResourceNameRestriction The resource name parameter 'notificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1549    		 RPC-Uri-V1-05
    ❌ ResourceNameRestriction The resource name parameter 'notificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1646    		 RPC-Uri-V1-05
    ❌ ResourceNameRestriction The resource name parameter 'notificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1694    		 RPC-Uri-V1-05
    ❌ ResourceNameRestriction The resource name parameter 'notificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1849    		 RPC-Uri-V1-05
    ❌ ResourceNameRestriction The resource name parameter 'notificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1897    		 RPC-Uri-V1-05
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspacePolicyFragment_ListByService' does not match the response definition in the individual GET operation 'WorkspacePolicyFragment_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L2052
    ❌ 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/preview/2022-09-01-preview/apimworkspaces.json#L2228    		 RPC-Async-V1-01
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L2296    		 RPC-Async-V1-01
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceGroup_ListByService' does not match the response definition in the individual GET operation 'WorkspaceGroup_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L2421
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceSubscription_List' does not match the response definition in the individual GET operation 'WorkspaceSubscription_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L3001
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceApiVersionSet_ListByService' does not match the response definition in the individual GET operation 'WorkspaceApiVersionSet_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L3511
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'WorkspaceApi_ListByService' does not match the response definition in the individual GET operation 'WorkspaceApi_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L3865
    ❌ 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/preview/2022-09-01-preview/apimworkspaces.json#L4052    		 RPC-Async-V1-01
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L4108    		 RPC-Async-V1-01


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ 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/preview/2022-09-01-preview/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/preview/2022-09-01-preview/apimapis.json#L215
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/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/preview/2022-09-01-preview/apimapis.json#L523
    ❌ RepeatedPathInfo The 'apiId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L705
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L787
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L787
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L877
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L1241
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L1532
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L1810
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L2164
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L2520
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L2804
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L2967
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3011
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L3113
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3377
    ❌ UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3377
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L3467
    ❌ RepeatedPathInfo The 'apiId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L3663
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L3835
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L4140
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'ApiTagDescription_ListByService' does not match the response definition in the individual GET operation 'ApiTagDescription_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L4445
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'Tag_ListByApi' does not match the response definition in the individual GET operation 'Tag_GetByApi' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimapis.json#L4735
    ❌ 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/preview/2022-09-01-preview/apimapis.json#L5356
    ❌ GetCollectionResponseSchema 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/preview/2022-09-01-preview/apimapiversionsets.json#L37
    ❌ GetCollectionResponseSchema 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/preview/2022-09-01-preview/apimauthorizationproviders.json#L37
    ❌ GetCollectionResponseSchema 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/preview/2022-09-01-preview/apimauthorizationproviders.json#L275
    ❌ OperationIdNounVerb 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/preview/2022-09-01-preview/apimauthorizationproviders.json#L280
    ️❌Avocado: 9 Errors, 1 Warnings failed [Detail]
    Rule Message
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/api-version-sets is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimapiversionsets.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/api-version-sets/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimapiversionsets.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/updatecertificate is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/updatehostname is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/policySnippets is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimpolicysnippets.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/properties is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/properties/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/tenant/{}/git is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2019-12-01-preview/apimtenant.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/tenant/{}/git/listSecrets is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2019-12-01-preview/apimtenant.json
    ⚠️ CIRCULAR_REFERENCE The JSON file has a circular reference.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[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]
    ️️✔️TypeSpecAPIView 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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand] 
    Validation passes for TypeSpec Validation.
    ️️✔️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 Mar 9, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

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

    ️❌SDK Breaking Change Tracking failed [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 succeeded [Detail] [Expand]

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

    ️⚠️ azure-sdk-for-python-track2 warning [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 Mar 9, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/apimanagement/armapimanagement https://apiview.dev/Assemblies/Review/9fd41b652c244fa4ab843f34f11c1694
    JavaScript @azure/arm-apimanagement https://apiview.dev/Assemblies/Review/b78524807ba8427abcfa3808d7e3681b

    @ghost ghost added the API Management label Mar 9, 2023
    @solankisamir solankisamir added the 2022-09-01-preview APIM 2022-09-01-preview PRs label Mar 9, 2023
    @solankisamir solankisamir mentioned this pull request Mar 9, 2023
    Closed
    11 tasks
    @azure-sdk azure-sdk mentioned this pull request Mar 9, 2023
    Closed
    @azure-sdk azure-sdk mentioned this pull request Mar 9, 2023
    Closed
    This was referenced Mar 9, 2023
    Closed
    Closed
    @openapi-workflow-bot
    Copy link

    Hi @solankisamir, 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.

    @openapi-workflow-bot
    Copy link

    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

    @azure-sdk azure-sdk mentioned this pull request Mar 9, 2023
    Closed
    @azure-sdk azure-sdk mentioned this pull request Mar 9, 2023
    Closed
    @mentat9
    Copy link
    Member

    mentat9 commented Mar 10, 2023

    @solankisamir - Please complete the ARM API Review Checklist section of the submission form.

    @mentat9 mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 10, 2023
    @solankisamir solankisamir added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 25, 2023
    @solankisamir
    Copy link
    Member Author

    solankisamir commented Apr 25, 2023 •
    edited
    Loading

    @sjanamma I have created a PR to fix the linter errors #23706. For other issues which require us to remodel the service side code I have opened the following issues on our team

    #21111
    #23702
    #23419
    #23418

    @sjanamma
    Copy link

    sjanamma commented Apr 25, 2023 via email

    @pilor pilor added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 25, 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 Apr 25, 2023
    @pilor
    Copy link
    Contributor

    pilor commented Apr 25, 2023

    Please only put this back into WaitForARMFeedback when your linter error PR merges into the source branch

    @solankisamir
    New ApiVersion 2022-09-01-preview : Fix Linter errors (#23706)
    e6e61df 
    * x-ms-pageable extension for all list calls on policy

* x-ms-secret to secret values

* location header and invalid produces
    @solankisamir solankisamir removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 26, 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 Apr 26, 2023
    @solankisamir
    Copy link
    Member Author

    @pilor

    Please only put this back into WaitForARMFeedback when your linter error PR merges into the source branch

    Our fixes for linter errors went in. For other issues, we have created issues to track it for future api-release

    @solankisamir
    Copy link
    Member Author

    solankisamir commented Apr 26, 2023 •
    edited
    Loading

    @weidongxu-microsoft
    I have opened the following bug on validation for the AutoRest team
    #23737

    @pilor pilor added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 26, 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 Apr 26, 2023
    @solankisamir
    Copy link
    Member Author

    @weidongxu-microsoft can you please take a look at this PR? I believe it is ready to merge.

    I have some more fixed in the #23739 which @live1206 is helping to merge.

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented Apr 27, 2023 •
    edited
    Loading

    Please check Avocado and LintDiff CI failure.

    The fix PR seems not able to solve Avocado.

    @solankisamir
    New Api-Version 2022-09-01-preview: Linter Errors (#23739)
    b9e6dd2 
    * boolean to x-ms-enum

* add location header to 202 response

* Location header to all 202 operations
    @solankisamir
    Copy link
    Member Author

    Please check Avocado and LintDiff CI failure.

    The fix PR seems not able to solve Avocado.

    Thanks @weidongxu-microsoft, I had done analysis of the Avacado failures

    #22978 (comment)

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented Apr 27, 2023 •
    edited
    Loading

    @weidongxu-microsoft The Swagger Avacode can be ignored as all these paths are deprecated in older api-versions

    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/api-version-sets is not in the default tag.
    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/updatecertificate is not in the default tag
    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/policySnippets is not in the default tag
    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/properties is not in the default tag.
    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/properties/{} is not in the default tag.
    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/tenant/{}/git is not in the default tag.
    API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiManagement/service/{}/tenant/{}/git/listSecrets is not in the default tag

    @josefree for any objection.

    Currently there is no suppression for Avocado. Hence these will need to be confirmed and approved in every PR...

    @weidongxu-microsoft
    Copy link
    Member

    There is some valid LintDiff, that would involve change in backend.

    1. "count" should be removed from List response
    2. PATCH may need to use a dedicated model, with only patchable properties
    3. LRO PUT should use 201 and Azure-AsyncOperation header
    4. "apiId" happen on path and body

    These should be addressed before GA.

    @weidongxu-microsoft weidongxu-microsoft merged commit 7dd1b5a into main Apr 28, 2023
    @weidongxu-microsoft weidongxu-microsoft deleted the release-apimanagement-2022-09-01-preview branch April 28, 2023 00:27
    This was referenced Apr 28, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    @solankisamir solankisamir mentioned this pull request Mar 22, 2024
    Merged
    7 tasks
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @weidongxu-microsoft weidongxu-microsoft weidongxu-microsoft approved these changes

    Assignees

    @weidongxu-microsoft weidongxu-microsoft

    Labels
    2022-09-01-preview APIM 2022-09-01-preview PRs API Management Approved-Avocado Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure CI-MissingBaseCommit new-api-version resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    8 participants
    @solankisamir @mentat9 @weidongxu-microsoft @sjanamma @pilor @AzureRestAPISpecReview @m-h-s @promoisha