azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Adding Group Quota APIs

Open rahuls-microsoft opened this issue 1 year ago • 7 comments

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: :warning:

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.

rahuls-microsoft avatar May 15 '23 17:05 rahuls-microsoft

Hi, @rahuls-microsoft 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]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView 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.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    ️️✔️Automated merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️🔄 $(sdkName) inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

    Hi, @rahuls-microsoft, 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

    Hi @rahuls-microsoft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @rkmanda This API is for MG level GroupQuota, which can be distributed to subscriptions by the MG owner. That's why all the APIs start with MG.

    Can we get exceptions for the Lint Error - API should start with Subscriptions. Please let's know, if you have any questions.

    rahuls-microsoft avatar Jul 11 '23 21:07 rahuls-microsoft

    Hi @rahuls-microsoft! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic ValidationFix-SemanticValidation-ErrorHigh
    Model ValidationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffHigh

    If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

    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.

    Hi @rahuls-microsoft, the following errors from https://github.com/Azure/azure-rest-api-specs/pull/23990/checks?check_run_id=15606221707 still exist. Please fix them. If you think some of them are expected and cannot be fixed, please follow this guidance to suppress them and we will review the suppression, thanks. image

    ms-zhenhua avatar Aug 07 '23 03:08 ms-zhenhua

    Hi @rahuls-microsoft, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

    Swagger Validation Report

    ️🔄BreakingChange inProgress [Detail]
    ️🔄Breaking Change(Cross-Version) inProgress [Detail]
    ️⌛CredScan pending [Detail]
    ️🔄LintDiff inProgress [Detail]
    ️⌛Avocado pending [Detail]
    ️🔄SwaggerAPIView inProgress [Detail]
    ️🔄TypeSpecAPIView inProgress [Detail]
    ️🔄ModelValidation inProgress [Detail]
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️🔄SpellCheck inProgress [Detail]
    ️🔄Lint(RPaaS) inProgress [Detail]
    ️⌛PR Summary pending [Detail]
    ️⌛Automated merging requirements met pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    /azp run

    konrad-jamrozik avatar Aug 14 '23 02:08 konrad-jamrozik

    Azure Pipelines successfully started running 2 pipeline(s).

    azure-pipelines[bot] avatar Aug 14 '23 02:08 azure-pipelines[bot]

    Next Steps to Merge

    ✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

    this js sdk breaking is caused by this pr

    kazrael2119 avatar Aug 17 '23 06:08 kazrael2119

    For Suppressions - The APi is at MG level, so Api starting at SubscriptionId is suppressed. Please let us know, if there is any further clarifications needed.

    rahuls-microsoft avatar Aug 22 '23 23:08 rahuls-microsoft

    For Suppressions - The APi is at MG level, so Api starting at Subscription ID is suppressed.

    rahuls-microsoft avatar Aug 22 '23 23:08 rahuls-microsoft

    For Suppressions - The APi is at MG level, so Api starting at Subscription ID is suppressed.

    rahuls-microsoft avatar Aug 22 '23 23:08 rahuls-microsoft

    For Suppressions - The APi is at MG level, so Api starting at SubscriptionId is suppressed.

    rahuls-microsoft avatar Aug 22 '23 23:08 rahuls-microsoft

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

    /azp run

    rahuls-microsoft avatar May 02 '24 18:05 rahuls-microsoft