Azure
[ACS Chat] [Rest API] Added chat thread metadata and participant meta…
Data Plane API - Pull Request
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:
❔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
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
Helpful Links
Hi, @angiurgiu! Thank you for your pull request. To help get your PR merged:
Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. ![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 8 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationserviceschat.json | 2023-07-01-preview(b0d4098) | 2023-07-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-chat-2023-07-01-preview | package-chat-2023-07-01-preview(b0d4098) | package-chat-2023-07-01-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
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/2023-07-01-preview/communicationserviceschat.json#L781 |
|
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/2023-07-01-preview/communicationserviceschat.json#L858 |
|
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/2023-07-01-preview/communicationserviceschat.json#L934 |
|
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/2023-07-01-preview/communicationserviceschat.json#L1006 |
|
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/2023-07-01-preview/communicationserviceschat.json#L1069 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1819 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L20 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L45 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L52 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L59 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L66 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L73 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L104 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L124 |
| :warning: SuccessResponseBody | All success responses except 202 & 204 should define a response body. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L125 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L128 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L135 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L142 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L149 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L178 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L198 |
| :warning: Post201Response | Using post for a create operation is discouraged. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L199 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L205 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L212 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L219 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L226 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L250 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L275 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L282 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L289 |
️️✔️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.
️️✔️All merging requirements met succeeded [Detail] [Expand]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger pipeline restarted successfully, please wait for status update in this comment.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | communication-data-plane-Chat | https://apiview.dev/Assemblies/Review/ffbfdb8483284ef1a2f132fa838b065a |
Hi @angiurgiu! The automation detected this pull request introduces changes to at least one existing API version that violate Azure's versioning policy. To comply with the policy, these changes must be made in a new API version. As a result, the automation added the NewApiVersionRequired label.
You cannot proceed with merging this PR until you complete one of the following action items:
ACTION ITEM ALTERNATIVE A: Introduce a new API version.
Submit a new PR instead of this one, or modify this PR, so that it adds a new API version instead of introducing changes to existing API versions.
ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot avoid modifying existing API versions, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.
ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no changes in existing API version, i.e. there should be no NewApiVersionRequired label, then proceed as explained in ACTION ITEM ALTERNATIVE B.
This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary.
For additional guidance, please see https://aka.ms/NewApiVersionRequired
Hi @angiurgiu! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.
You cannot proceed with merging this PR until you complete one of the following action items:
ACTION ITEM ALTERNATIVE A: Fix the breaking change.
Please consult the documentation provided in the relevant validation failures.
ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.
ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, then proceed as explained in ACTION ITEM ALTERNATIVE B.
This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary.