Skip to content

Conversation

talco773
Copy link

@talco773 talco773 commented May 22, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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, @talco773 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 22, 2023

    Swagger Validation Report

    ️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    customRecommedations.json 2023-05-01-preview(dd3fdee) 2023-05-01-preview(main)
    securityStandards.json 2023-05-01-preview(dd3fdee) 2023-05-01-preview(main)
    standardAssignments.json 2023-05-01-preview(dd3fdee) 2023-05-01-preview(main)
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2023-05-01-preview/customRecommedations.json#L37:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2023-05-01-preview/customRecommedations.json#L82:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2023-05-01-preview/securityStandards.json#L37:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2023-05-01-preview/securityStandards.json#L82:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2023-05-01-preview/standardAssignments.json#L37:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2023-05-01-preview/standardAssignments.json#L165:5
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⌛CredScan pending [Detail]
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.1.2) new version base version
    package-composite-v3 package-composite-v3(dd3fdee) package-composite-v3(main)
    ️🔄Avocado inProgress [Detail]
    ️⌛ApiReadinessCheck pending [Detail]
    ️⌛~[Staging] ServiceAPIReadinessTest pending [Detail]
    ️⌛SwaggerAPIView pending [Detail]
    ️⌛CadlAPIView pending [Detail]
    ️⌛TypeSpecAPIView pending [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️⌛PrettierCheck pending [Detail]
    ️⌛SpellCheck pending [Detail]
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️⌛CadlValidation pending [Detail]
    ️⌛TypeSpec Validation pending [Detail]
    ️⌛PR Summary pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 22, 2023

    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.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 22, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.Security https://apiview.dev/Assemblies/Review/df88a164a775411a8efbd1246c6ce893

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 22, 2023
    @openapi-workflow-bot
    Copy link

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

    @talco773 talco773 added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 11, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 11, 2023
    @talco773
    Copy link
    Author

    What is left to do before the merge? I already got signoff

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 11, 2023
    @openapi-workflow-bot
    Copy link

    Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    This will notify the reviewer to have another look.
    If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
    Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

    @talco773 talco773 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 12, 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 Jul 12, 2023
    @visingla-ms visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 24, 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 Jul 24, 2023
    @visingla-ms
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    No commit pushedDate could be found for PR 24090 in repo Azure/azure-rest-api-specs

    @visingla-ms visingla-ms added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Jul 24, 2023
    @@ -0,0 +1,380 @@
    {
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Please check, as your PR is labeled with "NewApiVersionRequired", which means that adding new API paths to an existing API Version are breaking changes.

    Please add these changes to a new Preview API Version,or get a breaking changes approval from Azure Breaking Changes Reviewers [email protected] and ARM can review the changes afterwards. Once you have the approval, please remove the "ARMChangesRequested" label from the PR to make the PR visible to the ARM reviewers.

    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    2 similar comments
    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    2 similar comments
    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @microsoft-github-policy-service
    Copy link
    Contributor

    Hi, @talco773. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview CI-BreakingChange-Go CI-BreakingChange-JavaScript new-api-version NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    10 participants