[Hub Generated] Review request for Search to add version preview/2022-12-01-preview #24161
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
|
Hi, @koyasu221b 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| search.json | 2022-12-01-preview(c7fc187) | 2022-12-01-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.2) | new version | base version |
|---|---|---|
| package-preview-2022-12 | package-preview-2022-12(c7fc187) | package-preview-2022-12(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L289 |
|
| Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L435 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L435 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L435 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L442 |
|
| Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L483 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L483 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L483 |
|
| Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L543 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L543 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L543 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L550 |
|
| Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L597 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L597 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L597 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L604 |
|
| Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L645 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L645 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L645 |
|
| Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L653 |
|
| Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L919 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2022-12-01-preview/search.json#L944 |
|
| Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L972 |
|
| Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L978 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2022-12-01-preview/search.json#L1001 |
|
| Property should have a description. Location: Search/preview/2022-12-01-preview/search.json#L1001 |
|
| Property should have a description. Location: Search/preview/2022-12-01-preview/search.json#L1003 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2022-12-01-preview/search.json#L1089 |
|
| Property should have a description. Location: Search/preview/2022-12-01-preview/search.json#L1089 |
️️✔️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 succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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
|
ghost
added
the
koyasu221b
requested review from
JeffreyRichter and
MushMal
and removed request for
a team
koyasu221b
force-pushed
the
koyasu221b-maps-Search-2022-12-01-preview
branch
from
3c521fc to
c7fc187
Compare
JeffreyRichter
approved these changes
May 25, 2023
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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