Sip - remove example and update description.

[dzeliar]

Data Plane API - Pull Request

API Info: The Basics

Non-breaking update of the description & example for purpose of generating a correct documentation. Tracking story: https://dev.azure.com/msft-skilling/Content/_workitems/edit/95672

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• [x ] a public preview
• GA release

Change Scope

This is a non-breaking change that contains the following updates:

• remove trailing / in TestRoutesWithNumber example URL to fix double // in generated example
• remove "to be validated" from domain description as all the domain available in this endpoint are already validated
• remove GetSipConfiguration example. The generated documentation always includes optional parameter if it is an enum with only single value.

❔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.

• 💬 Teams Channel
• 💌 email

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

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-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]

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
communicationservicessiprouting.json	2023-04-01-preview(cc853b9)	2023-04-01-preview(main)

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.3)	new version	base version
package-preview-2023-04	package-preview-2023-04(cc853b9)	package-preview-2023-04(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-04-01-preview/communicationservicessiprouting.json#L527
❌ HostParametersValidation	The host parameter must be typed 'type 'string', format 'url''. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L575
⚠️ PageableOperation	Based on the response model schema, operation 'SipRouting_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L13
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L13
⚠️ RequestBodyOptional	The body parameter is not marked as required. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L72
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L109
⚠️ RequestBodyOptional	The body parameter is not marked as required. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L133
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L149
⚠️ 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-04-01-preview/communicationservicessiprouting.json#L404

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

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

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

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

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

Validation passes for Summary.

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

[openapi-pipeline-app]

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	communication-data-plane-SipRouting	https://apiview.dev/Assemblies/Review/dcf66c9492f14c90ac671608160faffc

[dzeliar]

Hello @markweitzel , @mikekistler. Could you please do an async review of this change without a board review? We need to rollout generated API documentation ASAP as this is a blocker to go live. The PR doesn't include any changes to the API functionality, it only updates definition and examples to fix issues we have with generated documentation.
Here is the list of changes:

• remove trailing / in TestRoutesWithNumber example URL to fix double // in generated example
• remove "to be validated" from domain description as all the domain available in this endpoint are already validated
• remove GetSipConfiguration example. The generated documentation always includes optional parameter if it is an enum with only single value so we decided to get rid of this example.

[mikekistler]

Looks good! 👍

[mikekistler]

@jhendrixMSFT This is just a documentation update and all looks fine to me. It is good to merge.