[ACS][Communication][Chat] 2024-03-15-preview public preview API spec

[jimchou-dev]

Data Plane API - Pull Request

This PR includes previously approved features:

• Data retention feature https://github.com/Azure/azure-rest-api-specs/pull/22858 (changes reverted because release date is pushed back)
• Image upload feature https://github.com/Azure/azure-rest-api-specs/pull/25697 (approved but not merged because release date is pushed back)

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
• [x] 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: https://microsoft.sharepoint-df.com/:w:/t/IC3SDK/Eb1TFJ62ixxLoMqgZYNGbiYBG54egqfVHF_2u9u4FFNqWA?e=g7XqHl
• Previous API Spec Doc: https://github.com/Azure/azure-rest-api-specs/pull/25697
• 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

• Azure DevTools Wiki

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.

fix https://github.com/Azure/azure-rest-api-specs/issues/25607

[openapi-pipeline-app[bot]]

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[bot]]

Swagger Validation Report

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

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 1 Warnings warning [Detail]

Compared specs (v0.10.5)	new version	base version
communicationserviceschat.json	2024-03-15-preview(2909af3)	2024-03-07(main)
communicationserviceschat.json	2024-03-15-preview(2909af3)	2023-11-15-preview(main)

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

Rule	Message
:warning: 1003 - RequestBodyFormatNoLongerSupported	The new version does not support 'application/merge-patch+json' as a request body format. New: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1132:9 Old: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L1132:9

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

There is no credential detected.

️⚠️LintDiff: 13 Warnings warning [Detail]

Compared specs (v2.2.0)	new version	base version
package-2024-03-15-preview	package-2024-03-15-preview(2909af3)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1219
:warning: Post201Response	Using post for a create operation is discouraged. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1240
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1246
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1248
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1276
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1283
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1290
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1316
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1318
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1341
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1348
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1363
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1365

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
❌ OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Chat' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L781
❌ OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Chat' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L858
❌ OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'ChatThread' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L934
❌ OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'ChatThread' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1006
❌ OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Chat' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1069
❌ HostParametersValidation	The host parameter must be typed 'type 'string', format 'url''. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L2147
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L20
:warning: DefaultResponse	Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L45
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L52
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L59
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L66
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L73
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L104
:warning: DefaultResponse	Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L124
:warning: SuccessResponseBody	All success responses except 202 & 204 should define a response body. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L125
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L128
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L135
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L142
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L149
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L178
:warning: DefaultResponse	Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L198
:warning: Post201Response	Using post for a create operation is discouraged. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L199
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L205
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L212
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L219
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L226
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L250
:warning: DefaultResponse	Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L275
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L282
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L289

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

Validation passes for Avocado.

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

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

️️✔️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[bot]]

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[bot]]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Chat	https://apiview.dev/Assemblies/Review/7de49151a2ee45d29d87eee0aa5da23b?revisionId=d4bf6b416576475588dbae332b131f62

[openapi-workflow-bot[bot]]

Hi @jimchou-dev! 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.

[openapi-pipeline-app[bot]]

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

[heaths]

You need to fix the ModelValidation errors as well.

[heaths]

Sorry that got closed. Seems I hit some key sequence accidentally that closes GitHub issues. 😬

[openapi-pipeline-app[bot]]

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

[jimchou-dev]

/pr Requestmerge

[jimchou-dev]

/pr RequestMerge