Skip to content

Comments

added Workspaces feature-related endpoints and contracts#23330

Merged
live1206 merged 8 commits intoAzure:release-apimanagement-2022-09-01-previewfrom
promoisha:gleb/workspaces
Apr 20, 2023
Merged

added Workspaces feature-related endpoints and contracts#23330
live1206 merged 8 commits intoAzure:release-apimanagement-2022-09-01-previewfrom
promoisha:gleb/workspaces

Conversation

@promoisha
Copy link
Contributor

@promoisha promoisha commented Mar 28, 2023

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

openapi-workflow-bot bot commented Mar 28, 2023

Hi, @promoisha 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 28, 2023

    Swagger pipeline started successfully, please wait for status update in this comment.

    1 similar comment
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 28, 2023

    Swagger pipeline started successfully, please wait for status update in this comment.

    @ghost ghost added the API Management label Mar 28, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 29, 2023

    Swagger pipeline started successfully, please wait for status update in this comment.

    1 similar comment
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 29, 2023

    Swagger pipeline started successfully, please wait for status update in this comment.

    @promoisha promoisha marked this pull request as ready for review March 29, 2023 18:36
    @promoisha promoisha requested a review from solankisamir as a code owner March 29, 2023 18:37
    @solankisamir solankisamir added the 2022-09-01-preview APIM 2022-09-01-preview PRs label Mar 29, 2023
    @solankisamir
    Copy link
    Member

    solankisamir commented Mar 29, 2023

    /azp run

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 29, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 4 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    apimanagement.json 2022-09-01-preview(0a516c5) 2022-08-01(main)
    apimanagement.json 2022-09-01-preview(0a516c5) 2022-04-01-preview(main)
    apimproducts.json 2022-09-01-preview(0a516c5) 2022-08-01(main)
    apimproducts.json 2022-09-01-preview(0a516c5) 2022-04-01-preview(main)
    apimtags.json 2022-09-01-preview(0a516c5) 2022-08-01(main)
    apimtags.json 2022-09-01-preview(0a516c5) 2022-04-01-preview(main)
    definitions.json 2022-09-01-preview(0a516c5) 2022-08-01(main)
    definitions.json 2022-09-01-preview(0a516c5) 2022-04-01-preview(main)

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

    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L4427:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json#L4142:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L5791:9
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json#L5454:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L4438:5
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json#L4153:5
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'count' renamed or removed?
    New: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L1432:7
    Old: Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json#L1343:7
    ️❌LintDiff: 48 Errors, 22 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2022-09 package-preview-2022-09(0a516c5) package-preview-2022-09(release-apimanagement-2022-09-01-preview)

    [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#L1750
    ❌ 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#L1973
    ❌ 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#L657
    ❌ 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#L834    		 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#L881    		 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#L1171
    ❌ 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#L1338    		 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#L1406    		 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#L1476
    ❌ ResourceNameRestriction The resource name parameter 'notificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json#L1530    		 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#L1627    		 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#L1675    		 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#L1830    		 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#L1878    		 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#L2033
    ❌ 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#L2206    		 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#L2274    		 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#L2398
    ❌ 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#L2978
    ❌ 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#L3488
    ❌ 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#L3842
    ❌ 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#L4029    		 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#L4085    		 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 'Product_ListByService' does not match the response definition in the individual GET operation 'Product_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L37
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'ProductPolicy_ListByProduct' does not match the response definition in the individual GET operation 'ProductPolicy_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L866
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'Tag_ListByProduct' does not match the response definition in the individual GET operation 'Tag_GetByProduct' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L1142
    ❌ 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/preview/2022-09-01-preview/apimproducts.json#L1682
    ❌ GetCollectionResponseSchema The response in the GET collection operation 'Tag_ListByService' does not match the response definition in the individual GET operation 'Tag_Get' .
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimtags.json#L37
    ❌ ArrayMustHaveType 'items.type' property must be truthy
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L4701
    ❌ MissingTypeObject The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L7683
    ❌ ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L7686
    ❌ MissingTypeObject The schema 'ContentItemContractProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L7803
    ❌ DefinitionsPropertiesNamesCamelCase Property name should be camel case.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L8125
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimanagement.json#L100
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimanagement.json#L104
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimanagement.json#L513
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L69
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L364
    ⚠️ PageableOperation Based on the response model schema, operation 'ProductPolicy_ListByProduct' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimproducts.json#L867
    ⚠️ PutInOperationName 'PUT' operation 'Tag_AssignToProduct' should use method name 'Create'. 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/apimproducts.json#L1310
    ⚠️ DeleteInOperationName 'DELETE' operation 'Tag_DetachFromProduct' should use method name 'Delete'. 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/apimproducts.json#L1362
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/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/preview/2022-09-01-preview/apimproducts.json#L1687
    ⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Tag_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema'
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/apimtags.json#L199
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L89
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L115
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L148
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L169
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L575
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L579
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L598
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L837
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json#L842
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️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.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️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 29, 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 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 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 29, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.ApiManagement https://apiview.dev/Assemblies/Review/8ed1701fe5224998a01c68a7ee31e79a
    Go sdk/resourcemanager/apimanagement/armapimanagement Create ApiView failed. Please ask PR assignee for help
    JavaScript @azure/arm-apimanagement https://apiview.dev/Assemblies/Review/7bc818c565784eab8875962966a596ed

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Mar 29, 2023

    Azure Pipelines successfully started running 1 pipeline(s).

    @azure-sdk azure-sdk mentioned this pull request Mar 29, 2023
    Closed
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 29, 2023
    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Mar 29, 2023

    Hi @promoisha, 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 Mar 29, 2023
    Closed
    Closed
    @azure-sdk azure-sdk mentioned this pull request Mar 29, 2023
    Closed
    @azure-sdk azure-sdk mentioned this pull request Mar 29, 2023
    Closed
    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies": {

    It will always be a single resource. No need for pagination.

    In reply to: 1489561502

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:4586 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}/listReferences": {

    Added a backlog for next preview

    #23418

    In reply to: 1489559956

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:2112 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

        "secondaryKey": {

    We only return this on POST action.

    In reply to: 1489560836

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json:7306 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          "type": "string",

    We only return this on POST action.

    In reply to: 1489555591

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json:7281 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          "type": "string",

    We only return this on POST action.

    In reply to: 1489555669

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json:7271 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          "type": "string",

    We only return this on POST action.

    In reply to: 1489560798

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json:7301 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments": {

    #23418

    In reply to: 1489559596

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:1829 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

      "head": {

    We dont have GET, only HEAD for this resource.

    In reply to: 1489559461

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:1690 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails": {

    #23418

    In reply to: 1489559291

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:1646 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers": {

    #23418

    In reply to: 1489558392

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:1463 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

              "$ref": "./definitions.json#/definitions/WorkspaceContract"

    Yes it is same contract as PUT and all properties are updatable.

    In reply to: 1489550195

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:266 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies": {

    This will only has 1 resource.

    In reply to: 1489551346

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:343 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          },

    #23419

    In reply to: 1489553054

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:823 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          "202": {

    #23419

    In reply to: 1489558028

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:1267 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          "202": {

    #23419

    In reply to: 1489559834

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:2047 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

    @solankisamir
    Copy link
    Member

    solankisamir commented Apr 4, 2023 

          "202": {

    https://github.com/Azure/azure-rest-api-specs/pull/22537/files#diff-9fa78c93f67e78617cc5760a51363474048fbe1eb01f8d11d74c33a8b5ba41b6

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:5850 in 7fbd7c8. [](commit_id = 7fbd7c8, deletion_comment = False)

    @rkmanda
    Copy link
    Member

    rkmanda commented Apr 4, 2023 

      "head": {

    head is valid for this use case

    In reply to: 1489559053

    Refers to: specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/apimworkspaces.json:1507 in b3cf967. [](commit_id = b3cf967, deletion_comment = False)

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

    solankisamir commented Apr 6, 2023

    @live1206 can you please approve and merge this? This is blocking our API Release.

    @live1206
    Copy link
    Member

    live1206 commented Apr 7, 2023

    @live1206 can you please approve and merge this? This is blocking our API Release.

    @solankisamir There are a bunch of LintDiff errors introduced in this PR, is it possible to fix them? If not, could you explain why?

    @promoisha
    Copy link
    Contributor Author

    promoisha commented Apr 17, 2023 •
    edited
    Loading

    @live1206 The PR mainly introduces the new /workspaces parent resource with child resources, which are the same ones we already have (e.g. /apis, /products, etc). Linter errors are about those child resources.
    Also, a bunch of errors are incorrect it seems (e.g. all those regarding collection contract being different from the one returned by individual GET, contract having the name property, when it doesn't).

    @live1206 live1206 merged commit 0e480de into Azure:release-apimanagement-2022-09-01-preview Apr 20, 2023
    weidongxu-microsoft pushed a commit that referenced this pull request Apr 28, 2023
    @solankisamir @m-h-s @promoisha
    Release apimanagement 2022 09 01 preview (#22978)
    7dd1b5a 
    * Adds base for updating Microsoft.ApiManagement from version stable/2022-08-01 to version 2022-09-01-preview

* Updates readme

* Updates API version in new specs and examples

* Add circuit breaker to the backend contract (#21320) (#23359)

* add circuit breaker to the backend contract

* resolve validation errors

* Revert "resolve validation errors" and last push

This reverts commit c557685.

* resolve validation errors

* run prettier

* stv2.1 (#23326)

* added Workspaces feature-related endpoints and contracts (#23330)

* added Workspaces feature-related endpoints and contracts

* cleanup

* prettier

* + examples

* - redundant examples

* link contracts for PUT

* typo

* Location header added to async operations

---------

Co-authored-by: promoisha <glfeokti@microsoft.com>

* New ApiVersion 2022-09-01-preview : Fix Linter errors (#23706)

* x-ms-pageable extension for all list calls on policy

* x-ms-secret to secret values

* location header and invalid produces

* New Api-Version 2022-09-01-preview: Linter Errors (#23739)

* boolean to x-ms-enum

* add location header to 202 response

* Location header to all 202 operations

---------

Co-authored-by: Mahsa Sadi <mahsa.sadi@utoronto.ca>
Co-authored-by: promoisha <feoktistovgg@gmail.com>
Co-authored-by: promoisha <glfeokti@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

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

    @live1206 live1206 live1206 approved these changes

    @solankisamir solankisamir solankisamir approved these changes

    Assignees

    @live1206 live1206

    Labels

    2022-09-01-preview APIM 2022-09-01-preview PRs API Management 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 resource-manager

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    6 participants

    @promoisha @solankisamir @visingla-ms @rkmanda @live1206 @AzureRestAPISpecReview