Sasavin/add template api spec #24424
Closed
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
Add To field in SendMessageResult and change examples used in SendMessageRequest
**Additional Changes** - Adding successful response info - Adding Examples
- Take comments into account - Big changes in the API due to spec and scope changes
SamuelSA
requested review from
DominikMe and
weidongxu-microsoft
and removed request for
a team
|
Hi, @SamuelSA Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-02-01-preview | package-2023-02-01-preview(6d8c9ad) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10 |
|
|
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L408 |
|
|
The host parameter must be typed 'type 'string', format 'url''. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L430 |
|
| Operation should have a summary or description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10 |
||
| Parameter should have a description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L25 |
||
| The body parameter is not marked as required. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L25 |
||
| A 202 response should include an Operation-Location response header. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L34 |
||
| Error response should contain a x-ms-error-code header. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L40 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L51 |
||
| 'GET' operation 'Stream_DownloadMedia' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L56 |
||
| OperationId for get method should contain 'Get' or 'list' Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L56 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L61 |
||
| Error response should contain a x-ms-error-code header. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L80 |
||
| Based on the response model schema, operation 'TemplateV2_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L91 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L91 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L91 |
||
| Parameter should have a description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L101 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L101 |
||
| Parameter should have a description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L108 |
||
| Parameter should have a description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L114 |
||
| Error response should contain a x-ms-error-code header. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L130 |
||
| Schema should have a description or title. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L142 |
||
| Schema should have a description or title. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L171 |
||
| Property should have a description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L184 |
||
| Schema should have a description or title. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L289 |
||
| Schema should have a description or title. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L361 |
||
| Property should have a defined type. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L387 |
||
| Security definition should have a description. Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L417 |
️❌Avocado: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The example JSON file is not referenced from the swagger file. readme: communication/data-plane/Messages/readme.md json: preview/2023-02-01-preview/examples/DownloadMedia.json |
|
The example JSON file is not referenced from the swagger file. readme: communication/data-plane/Messages/readme.md json: preview/2023-02-01-preview/examples/SendMessage.json |
️️✔️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: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
x-ms-example not found in NotificationMessages_SendMessage. Url: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10:15 |
|
x-ms-example not found in Stream_DownloadMedia. Url: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L51:14 |
|
x-ms-example not found in TemplateV2_List. Url: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L91:14 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json |
️️✔️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.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @SamuelSA, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jun 13, 2023
mikekistler
approved these changes
Jun 13, 2023
There was a problem hiding this comment.
This looks good for preview, but please consider the comments captured in #24216.
mikekistler
added
the
APIStewardshipBoard-SignedOff
This was
linked to
issues
Jun 14, 2023
|
Hi, @SamuelSA. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
|
Hi, @SamuelSA. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
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
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.
❔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