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.

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

feat(rp): Added flags to enable/disable portals #23799

Conversation

harunrst
Copy link
Contributor

@harunrst harunrst commented May 3, 2023

Added properties to enable/disable legacy and developer portals.

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.

@harunrst harunrst requested a review from solankisamir as a code owner May 3, 2023 08:04
@openapi-workflow-bot
Copy link

Hi, @harunrst 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 3, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 1 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    apimdeployment.json 2023-03-01-preview(4b64ccb) 2022-08-01(main)
    apimdeployment.json 2023-03-01-preview(4b64ccb) 2022-09-01-preview(main)

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

    Rule Message
    ⚠️ 1014 - RemovingHeader The new version removs a required header 'Location'.
    Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L236:15
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.1) new version base version
    package-preview-2023-03 package-preview-2023-03(4b64ccb) package-preview-2023-03(release-Microsoft.ApiManagement-2023-03-01-preview)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1623
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1628


    The following errors/warnings exist before current PR submission:

    Rule Message
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L57
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L365
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L365
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1939
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1945
    ⚠️ XmsLongRunningOperationOptions The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L255
    ⚠️ XmsLongRunningOperationOptions The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L341
    ⚠️ XmsLongRunningOperationOptions The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L452
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1069
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1074
    ⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1141
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1216
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1500
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1536
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1573
    ⚠️ 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/2023-03-01-preview/apimdeployment.json#L1872
    ⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1912
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1961
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1984
    ️️✔️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 May 3, 2023

    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?

    @ghost ghost added the API Management label May 3, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 3, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.ApiManagement https://apiview.dev/Assemblies/Review/a67e061a2c1a40f4a46687d12e098125
    Go sdk/resourcemanager/apimanagement/armapimanagement https://apiview.dev/Assemblies/Review/92d28c6bd83b4717802ecbabb52c2fd8
    JavaScript @azure/arm-apimanagement https://apiview.dev/Assemblies/Review/db7b8343590845fb9c652d4f372369cd

    @solankisamir solankisamir added the 2023-03-01-preview APIM 2023-03-01-preview PRs label May 3, 2023
    @solankisamir
    Copy link
    Member

    @harunrst please refer to this warning and update spec.

    https://github.com/Azure/azure-rest-api-specs/pull/23799/checks?check_run_id=13197927447

    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/2023-03-01-preview/apimdeployment.json#L1623

    @raych1 raych1 requested a review from zedy-wj May 4, 2023 00:17
    @harunrst
    Copy link
    Contributor Author

    harunrst commented May 4, 2023

    @harunrst please refer to this warning and update spec.

    https://github.com/Azure/azure-rest-api-specs/pull/23799/checks?check_run_id=13197927447

    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/2023-03-01-preview/apimdeployment.json#L1623

    @solankisamir hey, thanks for noticing. It seems correct with booleans, we don't have and we won't need any other options for these states of portals.

    @live1206 live1206 merged commit 001f896 into Azure:release-Microsoft.ApiManagement-2023-03-01-preview May 6, 2023
    live1206 pushed a commit that referenced this pull request Jun 25, 2023
    * Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * feat(apim): Provide capability to use custom hostname for Configuration API v2 (#23785)
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * feat(rp): Added flags to enable/disable portals (#23799)
    
    * feat(rp): Added flags to enable/disable portals
    
    * update default
    
    * feat(apim): Provide capability to disable legacy configuration API  (#23786)
    
    * feat(apim): Provide capability to disable legacy configuration API
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Update sample
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Fix type definition
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Switch to enum
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Update samples
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    ---------
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * feat(apim): Add new tracing API (#23800)
    
    * Add new tracing api
    
    * Remove TODOs descriptions
    
    * Improve descriptions
    
    * Fix dot
    
    * Add missing examples
    
    * prettier fixes
    
    * Fix model and semantic problems
    
    * Remove get prefix in post operations
    
    * Use list prefix
    
    * Fix PR comments
    
    * feat(apim): Add ability to create and update new OData api (#23849)
    
    * Add odata api definitions
    
    * add api usage example
    
    * fix file reference
    
    * address comments
    
    ---------
    
    Co-authored-by: rkolesnikov <[email protected]>
    
    * migration contract (#23983)
    
    * 2023 03 cred scan fix - Examples Only (#24357)
    
    * remove-sas-signature
    
    * update example
    
    * 2023-03-01-preview arm review feedback (#24404)
    
    * move to v5 subscription contract
    
    * move to v5 for rg and api-version
    
    * cred scan
    
    * default is true
    
    * uuid in examples
    
    * change from boolean to enums
    
    * fix default value
    
    ---------
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    Co-authored-by: Tom Kerkhove <[email protected]>
    Co-authored-by: Harun Reşit <[email protected]>
    Co-authored-by: Rafał Mielowski <[email protected]>
    Co-authored-by: Roman Kolesnikov <[email protected]>
    Co-authored-by: rkolesnikov <[email protected]>
    harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023
    * Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * feat(apim): Provide capability to use custom hostname for Configuration API v2 (Azure#23785)
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * feat(rp): Added flags to enable/disable portals (Azure#23799)
    
    * feat(rp): Added flags to enable/disable portals
    
    * update default
    
    * feat(apim): Provide capability to disable legacy configuration API  (Azure#23786)
    
    * feat(apim): Provide capability to disable legacy configuration API
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Update sample
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Fix type definition
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Switch to enum
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * Update samples
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    ---------
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    
    * feat(apim): Add new tracing API (Azure#23800)
    
    * Add new tracing api
    
    * Remove TODOs descriptions
    
    * Improve descriptions
    
    * Fix dot
    
    * Add missing examples
    
    * prettier fixes
    
    * Fix model and semantic problems
    
    * Remove get prefix in post operations
    
    * Use list prefix
    
    * Fix PR comments
    
    * feat(apim): Add ability to create and update new OData api (Azure#23849)
    
    * Add odata api definitions
    
    * add api usage example
    
    * fix file reference
    
    * address comments
    
    ---------
    
    Co-authored-by: rkolesnikov <[email protected]>
    
    * migration contract (Azure#23983)
    
    * 2023 03 cred scan fix - Examples Only (Azure#24357)
    
    * remove-sas-signature
    
    * update example
    
    * 2023-03-01-preview arm review feedback (Azure#24404)
    
    * move to v5 subscription contract
    
    * move to v5 for rg and api-version
    
    * cred scan
    
    * default is true
    
    * uuid in examples
    
    * change from boolean to enums
    
    * fix default value
    
    ---------
    
    Signed-off-by: Tom Kerkhove <[email protected]>
    Co-authored-by: Tom Kerkhove <[email protected]>
    Co-authored-by: Harun Reşit <[email protected]>
    Co-authored-by: Rafał Mielowski <[email protected]>
    Co-authored-by: Roman Kolesnikov <[email protected]>
    Co-authored-by: rkolesnikov <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants