[ACS][Communication][Chat] 2024-03-15-preview public preview API spec#27225
Merged
ms-zhenhua merged 25 commits intomainfrom Mar 21, 2024
Merged
[ACS][Communication][Chat] 2024-03-15-preview public preview API spec#27225ms-zhenhua merged 25 commits intomainfrom
ms-zhenhua merged 25 commits intomainfrom
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| 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 |
|---|---|
| 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] |
|---|---|---|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1219 |
||
| Using post for a create operation is discouraged. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1240 |
||
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1246 |
||
The error property in the error response schema should be required.Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1248 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1276 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1283 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1290 |
||
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1316 |
||
The error property in the error response schema should be required.Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1318 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1341 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1348 |
||
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L1363 |
||
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 |
|---|---|
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L2147 |
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L20 |
|
| Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L45 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L52 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L59 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L66 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L73 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L104 |
|
| Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L124 |
|
| All success responses except 202 & 204 should define a response body. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L125 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L128 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L135 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L142 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L149 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L178 |
|
| Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L198 |
|
| Using post for a create operation is discouraged. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L199 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L205 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L212 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L219 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L226 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L250 |
|
| Operation is missing a default response. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L275 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2024-03-15-preview/communicationserviceschat.json#L282 |
|
| 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]
Swagger Generation Artifacts
|
Generated ApiView
|
|
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. |
jimchou-dev
changed the title
mikekistler
approved these changes
Jan 29, 2024
Member
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
I found a few minor problems.
The only egregious one is the "application/merge-patch+json" content type on Post for /chat/threads/{chatThreadId}/typing -- please remove that.
The others should also be fixed but no required for preview.
I'll approve as the changes are minor.
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Outdated
Show resolved
Hide resolved
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Show resolved
Hide resolved
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Show resolved
Hide resolved
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Show resolved
Hide resolved
heaths
requested changes
Jan 30, 2024
Member
heaths
left a comment
heaths
left a comment
There was a problem hiding this comment.
A few comments added in APIView, and discussed in our review meeting. Close to being good enough for a preview, though.
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
heaths
reviewed
Feb 2, 2024
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Outdated
Show resolved
Hide resolved
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Outdated
Show resolved
Hide resolved
...tion/communication/data-plane/Chat/preview/2024-03-15-preview/communicationserviceschat.json
Outdated
Show resolved
Hide resolved
heaths
approved these changes
Feb 2, 2024
Member
|
You need to fix the ModelValidation errors as well. |
Member
|
Sorry that got closed. Seems I hit some key sequence accidentally that closes GitHub issues. 😬 |
heaths
added
the
APIStewardshipBoard-SignedOff
jimchou-dev
requested review from
MushMal and
vicancy
and removed request for
a team
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
Member
Author
|
/pr Requestmerge |
Member
Author
|
/pr RequestMerge |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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
This PR includes previously approved features:
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.
Is this review for (select one):
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.
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.
❔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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
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.fix #25607