Used latest common specification (2023-11-15)

[mikehang-msft]

Data Plane API - Pull Request

Updated to use the latest reference common specification version.

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.

• Link to API Spec engagement record issue:

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.

• 💬 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

• Schedule a data plane REST API spec review

Checks stuck in `queued` state?

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.

[openapi-pipeline-app]

Next Steps to Merge

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

[openapi-pipeline-app]

Swagger Validation Report

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

There are no breaking changes.

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

Compared specs (v0.10.5)	new version	base version
communicationservicesrooms.json	2024-04-15(6d23a32)	2023-06-14(main)
communicationservicesrooms.json	2024-04-15(6d23a32)	2023-10-30-preview(main)

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

Rule	Message
❌ 1034 - AddedRequiredProperty	The new version has new required property 'pstnDialOutEnabled' that was not found in the old version. New: Rooms/stable/2024-04-15/communicationservicesrooms.json#L485:7 Old: Rooms/stable/2023-06-14/communicationservicesrooms.json#L480:7
❌ 1034 - AddedRequiredProperty	The new version has new required property 'pstnDialOutEnabled' that was not found in the old version. New: Rooms/stable/2024-04-15/communicationservicesrooms.json#L53:13 Old: Rooms/stable/2023-06-14/communicationservicesrooms.json#L53:13
❌ 1034 - AddedRequiredProperty	The new version has new required property 'pstnDialOutEnabled' that was not found in the old version. New: Rooms/stable/2024-04-15/communicationservicesrooms.json#L542:11 Old: Rooms/stable/2023-06-14/communicationservicesrooms.json#L533:11
❌ 1034 - AddedRequiredProperty	The new version has new required property 'pstnDialOutEnabled' that was not found in the old version. New: Rooms/stable/2024-04-15/communicationservicesrooms.json#L146:13 Old: Rooms/stable/2023-06-14/communicationservicesrooms.json#L146:13
❌ 1034 - AddedRequiredProperty	The new version has new required property 'pstnDialOutEnabled' that was not found in the old version. New: Rooms/stable/2024-04-15/communicationservicesrooms.json#L205:13 Old: Rooms/stable/2023-06-14/communicationservicesrooms.json#L205:13
❌ 1034 - AddedRequiredProperty	The new version has new required property 'pstnDialOutEnabled' that was not found in the old version. New: Rooms/stable/2024-04-15/communicationservicesrooms.json#L475:5 Old: Rooms/stable/2023-06-14/communicationservicesrooms.json#L471:5

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.0)	new version	base version
package-rooms-2024-04-15	package-rooms-2024-04-15(6d23a32)	default(release-communication-Rooms-2024-04-15)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ ParameterNamesConvention	header parameter name 'Repeatability-Request-ID' should be kebab case. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L28
⚠️ Post201Response	Using post for a create operation is discouraged. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L51
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L132
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L182
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L238
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L284
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L338
⚠️ 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: Rooms/stable/2024-04-15/communicationservicesrooms.json#L409
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L431
⚠️ 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: Rooms/stable/2024-04-15/communicationservicesrooms.json#L509
⚠️ 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: Rooms/stable/2024-04-15/communicationservicesrooms.json#L594

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

Validation passes for Avocado.

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

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ INVALID_TYPE	Expected type but found type object Url: Rooms/stable/2024-04-15/communicationservicesrooms.json#L358:22 ExampleUrl: stable/2024-04-15/examples/Participants_Update.json#L18:16

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

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

Validation passes for SpellCheck.

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

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Rooms	https://apiview.dev/Assemblies/Review/1917d4494bd94242aee2ae09a1751d63?revisionId=53c07311bd53401e8e16ae15611e0cd6

[mikekistler]

Looks good. 👍