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

Release BillingBenefits microsoft.billingbenefits preview/2024-11-01-preview #32829

Conversation

ryanmaley310
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2022-11-01 to preview/2024-11-01-preview.
Copy link

openapi-pipeline-app bot commented Feb 25, 2025

Next Steps to Merge

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

Copy link

openapi-pipeline-app bot commented Feb 25, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/billingbenefits/armbillingbenefits There is no API change compared with the previous version
JavaScript @azure/arm-billingbenefits https://apiview.dev/Assemblies/Review/ef86e65bcfbc4db99067e6b5f9bc0cf7?revisionId=7b07405d85b9483b92c5b26492f7080e
Python azure-mgmt-billingbenefits https://apiview.dev/Assemblies/Review/9a9fd46e74b445d094761dc1b02f0b51?revisionId=9e32bf4b2c6a40f797c4f90c4b3bc3bb
Java azure-resourcemanager-billingbenefits https://apiview.dev/Assemblies/Review/f03d447a259246dc83622fea0fdfcfe0?revisionId=121127f1398d4462b74150a894f62f7f

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Feb 25, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version NotReadyForARMReview resource-manager RPaaS labels Feb 25, 2025
@ryanmaley310 ryanmaley310 force-pushed the release-billingbenefits-Microsoft.BillingBenefits-preview/2024-11-01-preview branch from a7ace6a to b1b07cc Compare February 25, 2025 22:52
@AzureRestAPISpecReview AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test SuppressionReviewRequired labels Feb 25, 2025
@ryanmaley310 ryanmaley310 added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Feb 26, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Feb 26, 2025
@ryanmaley310
Copy link
Contributor Author

Note that all of these changes have been approved by ARM already and are merged into RPSaaSMaster branch:
https://github.com/Azure/azure-rest-api-specs-pr/pull/21109
https://github.com/Azure/azure-rest-api-specs-pr/pull/21516

@razvanbadea-msft razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 26, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 26, 2025
@@ -26,11 +26,13 @@ These are the global settings for the billingbenefits.

```yaml
openapi-type: arm
tag: package-2022-11-01
openapi-subtype: providerHub
tag: package-preview-2024-11-01
Copy link
Member

Choose a reason for hiding this comment

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

This tag definition doesn't exist in the readme.md. Either change to another valid tag name or add the definition for the tag.

Copy link
Member

@mikeharder mikeharder Feb 26, 2025

Choose a reason for hiding this comment

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

@raych1: I feel like some check should catch this and print a clear error message. Do you know which check should handle this? Maybe Avocado? Or maybe the language emitters should also check this as defense-in-depth and show a clear error message?

Revert .npmrc

Running prettier

revert .npmrc

Fixing tag defintion in readme

revert spacing in readme.go.md

fixing indentation error
@ryanmaley310 ryanmaley310 force-pushed the release-billingbenefits-Microsoft.BillingBenefits-preview/2024-11-01-preview branch from 1849eb4 to b8e2798 Compare February 26, 2025 18:41
@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.BillingBenefits

@ryanmaley310
Copy link
Contributor Author

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@ryanmaley310
Copy link
Contributor Author

/azp run ["Swagger SemanticValidation", "Swagger ModelValidation", "Swagger LintDiff", "Swagger Lint(RPaaS)", "Swagger BreakingChange", "SDK azure-sdk-for-go", "Breaking Change(Cross-Version)", "Automated merging requirements met"]

Copy link

No pipelines are associated with this pull request.

Copy link
Contributor

@sornaks sornaks left a comment

Choose a reason for hiding this comment

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

Approved for merge

@ryanmaley310 ryanmaley310 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Feb 26, 2025
@ryanmaley310 ryanmaley310 merged commit 3e74e85 into Azure:main Feb 26, 2025
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants