[Azure Maps] Data V2 and Data Registry API description update #23594
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
chcmsft
requested review from
JeffreyRichter and
mikekistler
and removed request for
a team
|
Hi, @chcmsft 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 |
|---|---|---|
| data.json | 2.0(647e9ca) | 2.0(main) |
| dataregistry.json | 2022-12-01-preview(647e9ca) | 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.0.0) | new version | base version |
|---|---|---|
| 2.0-preview | 2.0-preview(647e9ca) | 2.0-preview(main) |
| package-preview-2022-09 | package-preview-2022-09(647e9ca) | package-preview-2022-09(main) |
| 2022-12-01-preview | 2022-12-01-preview(647e9ca) | 2022-12-01-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 |
|---|---|
|
A 'post' operation 'Data_Upload' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201 or 202 or 204. Location: Creator/preview/2.0/data.json#L128 |
|
A 'post' operation 'Data_Upload' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201 or 202 or 204. Location: Creator/preview/2.0/data.json#L128 |
|
A 'put' operation 'Data_Update' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201 or 202. Location: Creator/preview/2.0/data.json#L212 |
|
A 'put' operation 'Data_Update' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201 or 202. Location: Creator/preview/2.0/data.json#L212 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataRegistry' 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: DataRegistry/preview/2022-12-01-preview/dataregistry.json#L143 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Creator/preview/2.0/data.json#L5 |
|
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Creator/preview/2.0/data.json#L5 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/data.json#L148 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/data.json#L148 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/data.json#L174 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/data.json#L174 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/data.json#L174 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/data.json#L174 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/data.json#L174 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/data.json#L174 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/data.json#L177 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/data.json#L177 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/data.json#L177 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/data.json#L177 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/data.json#L177 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/data.json#L177 |
|
| Based on the response model schema, operation 'Data_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2.0/data.json#L182 |
|
| Based on the response model schema, operation 'Data_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2.0/data.json#L182 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2.0/data.json#L182 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2.0/data.json#L182 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/data.json#L194 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2.0/data.json#L194 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/data.json#L205 |
|
The error property in the error response schema should be required.Location: Creator/preview/2.0/data.json#L205 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2.0/data.json#L205 |
️️✔️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: 6 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Response statusCode 200 for operation Data_Upload has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Creator/preview/2.0/data.json#L167:22 ExampleUrl: 2.0/examples/data/Data_Upload.json#L26:16 |
|
Response statusCode 409 for operation Data_Upload has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Creator/preview/2.0/data.json#L167:22 ExampleUrl: 2.0/examples/data/Data_Upload.json#L26:16 |
|
Response statusCode 200 for operation Data_Update has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Creator/preview/2.0/data.json#L247:22 ExampleUrl: 2.0/examples/data/Data_Update.json#L26:16 |
|
Response statusCode 409 for operation Data_Update has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Creator/preview/2.0/data.json#L247:22 ExampleUrl: 2.0/examples/data/Data_Update.json#L26:16 |
|
Response statusCode 200 for operation Data_GetOperation has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Creator/preview/2.0/data.json#L353:22 ExampleUrl: 2.0/examples/data/Data_GetOperationStillRunning.json#L7:16 |
|
Response statusCode 200 for operation Data_GetOperation has response body provided in the example, however the response does not have a "schema" defined in the swagger spec. Url: Creator/preview/2.0/data.json#L353:22 ExampleUrl: 2.0/examples/data/Data_GetOperation.json#L7: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 @chcmsft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
JeffreyRichter
approved these changes
Apr 19, 2023
|
Hi, @chcmsft. 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
|
@tjprescott Can you merge this? The model validation issues are pre-existing. |
|
@chcmsft I cannot merge PRs that aren't green. |
|
@lmazuel Can you help to merge? The model validation issues are preexisting. |
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