[Communication][Chat] Promote file attachment type from Beta -> GA #27395
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emlynmac
requested review from
DominikMe and
mikekistler
and removed request for
a team
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). |
Swagger Validation Report
|
| 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 |
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L20 |
|
| Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L45 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L52 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L59 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L66 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L73 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L104 |
|
| Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L124 |
|
| All success responses except 202 & 204 should define a response body. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L125 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L128 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L135 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L142 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L149 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L178 |
|
| Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L198 |
|
| Using post for a create operation is discouraged. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L199 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L205 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L212 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L219 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L226 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/stable/2024-03-07/communicationserviceschat.json#L250 |
|
| Operation is missing a default response. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L275 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/stable/2024-03-07/communicationserviceschat.json#L282 |
|
| 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
|
Generated ApiView
|
JeffreyRichter
approved these changes
Jan 24, 2024
JeffreyRichter
added
the
APIStewardshipBoard-SignedOff
|
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. |
microsoft-github-policy-service
bot
added
no-recent-activity
vxfield
pushed a commit
that referenced
this pull request
Mar 28, 2024
…27395) * Adds base for updating Chat from version stable/2023-11-07 to version 2024-03-07 * Updates readme * Updates API version in new specs and examples * Update communicationserviceschat.json * Update readme.md * Update readme.md * made tag names consistent --------- Co-authored-by: John <109105353+jpeng-ms@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Previous PR with beta version:
#23662
API Info: The Basics
GA release of the beta API, previously reviewed and approved. No additional changes.
Is this review for (select one):
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 ApiViewcomment 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.