[Communication - Telephony Service] Trunk status API

[dzeliar]

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
   • [x] 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"
• [x] I have reviewed the documentation for the workflow.
• [x] 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, @dzeliar 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]

[openapi-pipeline-app[bot]]

Swagger Validation Report

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

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.2)]	new version	base version
communicationservicessiprouting.json	2023-01-01-preview(4642bf0)	2022-10-01-preview(main)

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2023-01-01-preview	package-2023-01-01-preview(4642bf0)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ XmsParameterLocation	The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L530
❌ HostParametersValidation	The host parameter must be typed 'type 'string', format 'url''. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L562
:warning: PageableOperation	Based on the response model schema, operation 'SipRouting_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L13
:warning: PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L13
:warning: OperationId	OperationId for patch method should contain 'Update' Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L64
:warning: PatchInOperationName	'PATCH' operation 'SipRouting_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L64
:warning: RequestBodyOptional	The body parameter is not marked as required. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L75
:warning: PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L112
:warning: RequestBodyOptional	The body parameter is not marked as required. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L136
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L152
:warning: EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json#L407

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

Validation passes for Avocado.

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

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

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

️️✔️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.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{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 @dzeliar, 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.

[dzeliar]

Hello @scgbear, @weidongxu-microsoft please take a look and review

[weidongxu-microsoft]

@dzeliar Please see https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/271/Azure-REST-API-Stewardship

[dzeliar]

As I'll be OOF for the next two weeks, @nikuklic will address any comments

[weidongxu-microsoft]

There is no update to https://github.com/Azure/azure-rest-api-specs/issues/19349

Let reviewer know after meeting is scheduled and discussion is added (usually Mark's reply in issue).

[dzeliar]

Hello @weidongxu-microsoft , our review has been scheduled for today (Wed 29/06/2022)

[openapi-pipeline-app[bot]]

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

[openapi-workflow-bot[bot]]

NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[dzeliar]

Hello everyone,

on yesterdays board review of SipRouting - Trunk health, Issue #19376, we agreed on the following steps:

1, Rename SipConfigurationExpanded & TrunkExpanded -> ExpandedSipConfiguration & ExpandedTrunk 2, Unify naming Trunk vs. SBC vs. SessionBorderController. After review with our PM we unified naming and now we use only Trunk.

All changes we pushed and the PR is now ready to merge. In order to do so I need an approval from API Stewardship Board. Please, @mikekistler , @JeffreyRichter, @johanste approve the PR so I can proceed with merge. Thank you

[ghost]

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

[ghost]

Hi, @dzeliar. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

[openapi-workflow-bot[bot]]

Hi, @dzeliar, 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

[mikekistler]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[dzeliar]

Hello everyone,

on yesterdays board review of SipRouting - Trunk health, https://github.com/Azure/azure-rest-api-specs/issues/19376, we agreed on the following steps:

1. You should not create new schemas for Expanded SipConfiguration or ExpandedTrunk. Just add "health" as an optional property the the existing Trunk schema. You can mark health as readOnly: true for documentation purposes.
2. Don’t use the “$” prefix character on $expand
3. Enum value for expand should be "trunks/health"
4. Health should be a named schema that is $ref'ed from here. And any objects nested within Health should be described by separate named schemas -- not nested inline.

OpenAPI diff

I addressed all of the suggestions above. The changes were pushed, now I need an approval from API Stewardship Board. Please, @mikekistler , @JeffreyRichter, @DominikMe review and approve the PR so it can be merged. Thank you

[dzeliar]

Hello @mikekistler, I'm just checking on if you had a chance to review the last version where I implemented requested changes. As you mentioned in the created issue about APIView, APIView still doesn't display my last version properly but I hope it's not a blocker to merge this.

[dzeliar]

Thank you for reviews @mikekistler , @weidongxu-microsoft . As merging the PR is restricted to authorized users only, can any of the code-owners perform merge? cc @DominikMe , @scgbear , @JeffreyRichter

[mikekistler]

@lirenhe Could you please merge this PR.