Skip to content

Phone Numbers API version 2025-04-01#32573

Merged
danielortega-msft merged 27 commits intomainfrom
danielortega-msft/phonenumbers-cherrypicker-dnr-ga
Mar 31, 2025
Merged

Phone Numbers API version 2025-04-01#32573
danielortega-msft merged 27 commits intomainfrom
danielortega-msft/phonenumbers-cherrypicker-dnr-ga

Conversation

@danielortega-msft
Copy link
Copy Markdown
Contributor

@danielortega-msft danielortega-msft commented Feb 12, 2025

Data 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

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • 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.
  • 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.

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Feb 12, 2025

Next Steps to Merge

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

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Feb 12, 2025

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

@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 12, 2025
@azure-sdk
Copy link
Copy Markdown
Collaborator

azure-sdk commented Feb 12, 2025

API change check

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

CallAutomation-PhoneNumbers

@danielortega-msft
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

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.

@danielortega-msft danielortega-msft force-pushed the danielortega-msft/phonenumbers-cherrypicker-dnr-ga branch from 183b580 to 7ab1f79 Compare February 24, 2025 21:55
@danielortega-msft
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

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.

@danielortega-msft danielortega-msft added PublishToCustomers Acknowledgement the changes will be published to Azure customers. and removed resource-manager TypeSpec Authored with TypeSpec labels Feb 25, 2025
@danielortega-msft danielortega-msft enabled auto-merge (squash) March 18, 2025 22:47
@danielortega-msft
Copy link
Copy Markdown
Contributor Author

/azp run openapi-pipeline-app

@azure-pipelines
Copy link
Copy Markdown

No pipelines are associated with this pull request.

@danielortega-msft
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

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.

@mikeharder
Copy link
Copy Markdown
Member

mikeharder commented Mar 21, 2025

I pushed a change to this PR I believe should fix the problem in LintDiff:

64f22d1

The root cause, is @stoplight/json-ref-resolver can only reliably handle circular references, if the start of the circle is at the top-level of definitions within a file.

https://github.com/stoplightio/json-ref-resolver/blob/e4e2410e86edcc7a96e01d309039ad319ca40f2c/src/crawler.ts#L115-L118

So, if CommunicationErrorResponse is in a different JSON file than CommunicationError (which has a circular reference to CommunicationError), the circle can be detected immediately. So instead of running forever, it now completes on your spec in 3 seconds.

But if CommunicationErrorResponse and CommunicationError are siblings in the same JSON file, json-ref-resolver falls into a different codepath where it can't detect the cycle.

I believe my change is effectively a no-op for your spec, because the CommunicationErrorResponse object hasn't changed, just which json file contains it.

I also believe my change should be non-breaking, since I left the other copy of CommunicationErrorResponse in-place for existing specs (somehow) using it successfully.

Tracking: Azure/azure-openapi-validator#775

@danielortega-msft
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

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.

@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Mar 21, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview removed the TypeSpec Authored with TypeSpec label Mar 24, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 25, 2025
@danielortega-msft
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 4 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 25, 2025
@danielortega-msft danielortega-msft merged commit de9cb12 into main Mar 31, 2025
28 of 29 checks passed
@danielortega-msft danielortega-msft deleted the danielortega-msft/phonenumbers-cherrypicker-dnr-ga branch March 31, 2025 17:34
nwnt pushed a commit to nwnt/azure-rest-api-specs that referenced this pull request Jun 10, 2025
* Copy files from stable/2025-02-11

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to 2025-04-01

Updated the API version from 2025-02-11 to 2025-04-01

* Added tag for 2025-04-01 in readme file

* Fix readme

* Add changes for phone numbers version 2025-04-01

* Fix CI

* Avoid nested object def in phonenumbers swagger

* Make common error responses consistent

* Add missing property descriptions

* Address ARB feedback for reservations API

* Add description to PhoneNumbersReservation and specify ID formatting

* Update do not resell field names and descriptions

* Rename 'isDoNotResellAgreementRequired' to 'isAgreementToNotResellRequired' for consistency across phone number specifications

* minor fixes

* Add note on old reservation cleanup

* Move CommunicationErrorResponse into separate file to allow circular reference detection

* Add error.json to readme.md to fix Avocado

* Address applicable lintdiff warnings

* Define CommunicationError and CommunicationErrorResponse in phonenumbers.json

Prevents circular references

* consolidate CommunicationError references

* remove CommunicationError from phonenumbers.json

* define CommunicationErrorResponse inline

* add nullable to phone numbers in reservation

* Rename operationId to match convention

---------

Co-authored-by: Mike Harder <mharder@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. data-plane new-api-version PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IC3 ACS Management GW ] API Review

6 participants