PATCH /sip routing new version API swagger for review

[nostojicMs]

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

1. What's the purpose of the update?
   • [ ] new service onboarding
   • [x] 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. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
   • [ ] SDK of .NET (need service team to ensure code readiness)
   • [ ] SDK of Python
   • [ ] SDK of Java
   • [ ] SDK of Js
   • [ ] SDK of Go
   • [ ] PowerShell
   • [ ] CLI
   • [ ] Terraform
   • [ ] No refresh required for updates in this PR

Contribution checklist:

• [x] I commit to follow the Breaking Change Policy of "no breaking changes"
• [ ] I have reviewed the documentation for the workflow.
• [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

• [ ] Removing API(s) in a stable version
• [ ] Removing properties in a stable version
• [ ] Removing API version(s) in a stable version
• [ ] Updating API in a stable or public preview version with Breaking Change Validation errors
• [ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

Please follow the link to find more details on PR review process.

[openapi-workflow-bot[bot]]

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

[nostojicMs]

Hello @bexxx and @tg-msft kindly reminding you to take a look at this PR. Related issue to this PR: https://github.com/Azure/azure-rest-api-specs/issues/19503 Thank you

[openapi-pipeline-app[bot]]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️❌Breaking Change(Cross-Version): 5 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.9.7)]	new version	base version
communicationservicessiprouting.json	2022-09-01-preview(5230e0a)	2021-05-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
❌ 1008 - ModifiedOperationId	The operation id has been changed from 'GetSipConfiguration' to 'SipRouting_Get'. This will impact generated code. New: SipRouting/preview/2022-09-01-preview/communicationservicessiprouting.json#L13:7 Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L13:7
❌ 1008 - ModifiedOperationId	The operation id has been changed from 'PatchSipConfiguration' to 'SipRouting_Patch'. This will impact generated code. New: SipRouting/preview/2022-09-01-preview/communicationservicessiprouting.json#L53:7 Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L48:7
❌ 1034 - AddedRequiredProperty	The new version has new required property 'enabled' that was not found in the old version. New: SipRouting/preview/2022-09-01-preview/communicationservicessiprouting.json#L114:7 Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L124:7
❌ 1034 - AddedRequiredProperty	The new version has new required property 'enabled' that was not found in the old version. New: SipRouting/preview/2022-09-01-preview/communicationservicessiprouting.json#L207:11 Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L184:11
❌ 1034 - AddedRequiredProperty	The new version has new required property 'enabled' that was not found in the old version. New: SipRouting/preview/2022-09-01-preview/communicationservicessiprouting.json#L107:5 Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L118:5

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-09-01-preview	package-2022-09-01-preview(5230e0a)	default(main)

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]

Validation passes for ServiceAPIReadinessTest.

️️✔️~[Staging] TrafficValidation 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.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

• The following tags are being changed in this PR
• "https://github.com/Azure/azure-rest-api-specs/blob/5230e0aa0917f70d8edbbbf4058e4f4ac1381813/specification/communication/data-plane/SipRouting/readme.md#tag-package-2022-09-01-preview">communication/data-plane/SipRouting/readme.md#package-2022-09-01-preview

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

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

[openapi-workflow-bot[bot]]

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

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[openapi-workflow-bot[bot]]

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

[ghost]

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

[openapi-pipeline-app[bot]]

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

[nostojicMs]

This new version of Sip Routing API introduces breaking change by adding required parameter "Enabled" in response as part of "Trunks" and "Domains" in GET and PATCH methods. This change is introduced to show if Trunk and corresponding Domain is used (Enabled=true) in Sip configuration. Domain validation will be performed only to enabled Domains. If Domain is not enabled (Enabled=False) it will not be used in sip configuration. Trunks can be enabled only if corresponding Domain is enabled. Change of operation Ids in GET and PATCH are changed to follow recommended guidelines for constructing swagger. Since this is not still GA it's good opportunity to do this change.

cc PR assignee @jhendrixMSFT

[nostojicMs]

Hi, here's the link to the breaking change intake of renaming of operation id: https://msazure.visualstudio.com/One/_workitems/edit/15324575