Add pageable support for list functions#23308
Merged
Conversation
minnieliu
requested review from
DominikMe and
rysweet
and removed request for
a team
|
Hi, @minnieliu 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 swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationservicesrooms.json | 2023-03-31-preview(49ef466) | 2023-03-31-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.0.0) | new version | base version |
|---|---|---|
| package-rooms-2023-03-31-preview | package-rooms-2023-03-31-preview(49ef466) | package-rooms-2023-03-31-preview(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L28 |
|
| Using post for a create operation is discouraged. Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L51 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L132 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L182 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L238 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L284 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L338 |
|
| Schema should have a description or title. Location: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L422 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Expected type but found type object Url: Rooms/preview/2023-03-31-preview/communicationservicesrooms.json#L358:22 ExampleUrl: preview/2023-03-31-preview/examples/Participants_Update.json#L18:16 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️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 pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
|
Hi @minnieliu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
DominikMe
approved these changes
Mar 28, 2023
Member
|
Skipping model validation ref #22540 (comment) |
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* Add pageable support for list functions * nit --------- Co-authored-by: Minnie Liu <peiliu@microsoft.com>
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 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 Open API document (swagger) 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