SipRouting trunk setting sdk changes. #39858

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.

Sign up for GitHub

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

Jump to bottom

Open

v-pivamshi wants to merge 10 commits into main from v-pivamshi/feature/sip-settings-phone-numbers

Contributor

v-pivamshi commented Feb 25, 2025

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.


          SipRouting trunk setting sdk changes.

8d06900

github-actions bot added the Communication - Phone Numbers label

Collaborator

azure-sdk commented Feb 25, 2025

API change check

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

azure-communication-phonenumbers

Contributor Author

v-pivamshi commented Feb 26, 2025

User Story 3920786: SDK Implementation: Python

Generated swagger.
Added api changes.

jiriburant reviewed

View reviewed changes

...communication-phonenumbers/azure/communication/phonenumbers/siprouting/_generated/_client.py Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...unication-phonenumbers/azure/communication/phonenumbers/siprouting/_generated/aio/_client.py Show resolved Hide resolved


          resoleved credential issue.

360e62d

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved


          resolved the comment.

b240ef4

v-dharmarajv marked this pull request as ready for review

March 17, 2025 16:47

v-dharmarajv requested review from Arazan, whisper6284, danielortega-msft and sofiar-msft as code owners

March 17, 2025 16:47

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved


          resolved the comments.

0e8470a

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved


          added changes in SipTrunk and SipTrunkRoute models.

5d1388d

jiriburant reviewed

View reviewed changes

sdk/communication/azure-communication-phonenumbers/swagger/SIP_ROUTING_SWAGGER.md Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

sdk/communication/azure-communication-phonenumbers/swagger/SIP_ROUTING_SWAGGER.md Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Show resolved Hide resolved

v-pivamshi added 3 commits

April 8, 2025 15:32


          resoved the comments. and runthe latest autorest.

36d393a


          added domain endpoints.

3ee928c


          expose sip domain.

9e0d6ae

jiriburant reviewed

View reviewed changes

...ion/azure-communication-phonenumbers/azure/communication/phonenumbers/siprouting/__init__.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...tion/azure-communication-phonenumbers/azure/communication/phonenumbers/siprouting/_models.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py Outdated Show resolved Hide resolved

v-pivamshi added 2 commits

April 9, 2025 15:58


          resolved the comments.

eaa27b4


          reolved lint error.

5e50ade

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py

@@ @@ -238,10 +254,148 @@ async def set_routes( @@
                       ]
                       await self._rest_service.sip_routing.update(body=SipConfiguration(routes=routes_internal), **kwargs)
+                  @distributed_trace_async
+                  async def test_routes_with_number_async(

Member

jiriburant Apr 17, 2025 •

edited

Loading

Feedback from review:
Change the function def to:
async def get_routes_for_number(self, target_phone_number:str, test_routes: SipTrunkRoute[], **kwargs: Any) : # type: (...) -> SipTrunkRoute[]

Member

jiriburant Apr 17, 2025

The function accepts array of routes, internally maps it to SipConfiguration and sends it to API. The response "RoutesForNumber" object is not exposed, instead we just return the contained list of matching routes.

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py

@@ @@ -235,10 +249,148 @@ def set_routes( @@
                       ]
                       self._rest_service.sip_routing.update(body=SipConfiguration(routes=routes_internal), **kwargs)
+                  @distributed_trace
+                  def test_routes_with_number(

Member

jiriburant Apr 17, 2025

Feedback from review:
Change the function def to:
def get_routes_for_number(self, target_phone_number: str, test_routes: SipTrunkRoute[], **kwargs: Any): # type: (...) -> SipTrunkRoute[]

Member

jiriburant Apr 17, 2025

So, internally map the test_routes to sipConfiguration and send it to API. And when receiving the response from API, map the resulting RoutesForNumber to SipTrunkRoute[] and return only that.

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py

@@ @@ -83,20 +85,26 @@ def from_connection_string( @@
                   async def get_trunk(
                       self,
                       trunk_fqdn,  # type: str
+                      include_health: Optional[bool] = None,

Member

jiriburant Apr 17, 2025

Feedback from review:
Remove include_health parameter and just always return trunk health (always call the GET API with the ExpandEnum.TRUNKS_HEALTH parameter)

jiriburant reviewed

View reviewed changes

...on-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py

@@ @@ -141,10 +149,14 @@ async def delete_trunk( @@
                   @distributed_trace
                   def list_trunks(
-                      self, **kwargs  # type: Any
+                      self,
+                      include_health: Optional[bool] = None,

Member

jiriburant Apr 17, 2025

Feedback from review:
Remove include_health parameter and just always return trunk health (always call the GET API with the ExpandEnum.TRUNKS_HEALTH parameter)

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py

@@ @@ -138,10 +144,14 @@ def delete_trunk( @@
                   @distributed_trace
                   def list_trunks(
-                      self, **kwargs  # type: Any
+                      self,
+                      include_health: Optional[bool] = None,

Member

jiriburant Apr 17, 2025

Feedback from review:
Remove include_health parameter and just always return trunk health (always call the GET API with the ExpandEnum.TRUNKS_HEALTH parameter)

jiriburant reviewed

View reviewed changes

...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py

@@ @@ -80,20 +82,24 @@ def from_connection_string( @@
                   def get_trunk(
                       self,
                       trunk_fqdn,  # type: str
+                      include_health: Optional[bool] = None,

Member

jiriburant Apr 17, 2025

Feedback from review:
Remove include_health parameter and just always return trunk health (always call the GET API with the ExpandEnum.TRUNKS_HEALTH parameter)

jiriburant reviewed

View reviewed changes

sdk/communication/azure-communication-phonenumbers/swagger/SIP_ROUTING_SWAGGER.md

+                from: swagger-document
+                where: "$.definitions.OverallHealth"
+                transform: >
+                  $.properties.reason["x-ms-enum"].name = "UnhealthyStatusReason";

Member

jiriburant Apr 17, 2025 •

edited

Loading

Feedback from review:
Rename the UnhealthyStatusReason to HealthStatusReason, so change this directive to:

Directive renaming "InactiveStatusReason" enum to "HealthStatusReason"

directive:
  from: swagger-document
  where: "$.definitions.OverallHealth"
  transform: >
    $.properties.reason["x-ms-enum"].name = "HealthStatusReason";

And regenerate the code.

jiriburant reviewed

View reviewed changes

...tion/azure-communication-phonenumbers/azure/communication/phonenumbers/siprouting/_models.py

+                  }
+                  _attribute_map = {
+                      "enabled": {"key": "enabled", "type": "bool"},

Member

jiriburant Apr 17, 2025

missing "fqdn" property. Please add it and also add it to constructor (similarly as enabled).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jiriburant jiriburant left review comments

Arazan Awaiting requested review from Arazan Arazan is a code owner

whisper6284 Awaiting requested review from whisper6284 whisper6284 is a code owner

danielortega-msft Awaiting requested review from danielortega-msft danielortega-msft is a code owner

sofiar-msft Awaiting requested review from sofiar-msft sofiar-msft is a code owner

At least 1 approving review is required to merge this pull request.

Labels

Communication - Phone Numbers