Updating examples and documents#26840
Merged
Merged
Conversation
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 | 2023-11-15-preview(c2afccf) | 2023-11-15-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.6) | new version | base version |
|---|---|---|
| package-2023-11-15-preview | package-2023-11-15-preview(c2afccf) | package-2023-11-15-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-11-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/2023-11-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/2023-11-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/2023-11-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/2023-11-15-preview/communicationserviceschat.json#L1069 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L1812 |
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L20 |
|
| Operation is missing a default response. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L45 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L52 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L59 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L66 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L73 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L104 |
|
| Operation is missing a default response. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L124 |
|
| All success responses except 202 & 204 should define a response body. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L125 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L128 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L135 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L142 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L149 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L178 |
|
| Operation is missing a default response. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L198 |
|
| Using post for a create operation is discouraged. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L199 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L205 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L212 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L219 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L226 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L250 |
|
| Operation is missing a default response. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L275 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-15-preview/communicationserviceschat.json#L282 |
|
| Error response should contain a x-ms-error-code header. Location: Chat/preview/2023-11-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
|
jpeng-ms
reviewed
Nov 24, 2023
jpeng-ms
reviewed
Nov 24, 2023
JoshuaLai
requested review from
johanste and
tg-msft
and removed request for
a team
jhendrixMSFT
approved these changes
Nov 29, 2023
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
4 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
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 is just an update to examples and documentation
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.