azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Communication][Chat] Promote file attachment type from Beta -> GA
Data Plane API - Pull Request
Previous PR with beta version: https://github.com/Azure/azure-rest-api-specs/pull/23662
API Info: The Basics
GA release of the beta API, previously reviewed and approved. No additional changes.
- Link to API Spec engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [ ] a public preview
- [x] GA release
Change Scope
FileAttachmentType gains type "file" to GA.
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.
Helpful Links
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.
Next Steps to Merge
✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 5 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationserviceschat.json | 2024-03-07(45984f1) | 2023-11-07(main) |
| communicationserviceschat.json | 2024-03-07(45984f1) | 2023-11-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-chat-2024-03-07 | package-chat-2024-03-07(45984f1) | default(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/stable/2024-03-07/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/stable/2024-03-07/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/stable/2024-03-07/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/stable/2024-03-07/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/stable/2024-03-07/communicationserviceschat.json#L1069 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L1782 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L20 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L45 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L52 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L59 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L66 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L73 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L104 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L124 |
| :warning: SuccessResponseBody | All success responses except 202 & 204 should define a response body. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L125 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L128 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L135 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L142 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L149 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L178 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L198 |
| :warning: Post201Response | Using post for a create operation is discouraged. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L199 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L205 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L212 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L219 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L226 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L250 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L275 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L282 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/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]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Chat | https://apiview.dev/Assemblies/Review/7de49151a2ee45d29d87eee0aa5da23b?revisionId=1b295f8a300347c08b956daa232c6ed7 |
Hi @emlynmac! 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-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}