azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Maps - RevGeoCoding] Add version preview/2022-12-01-preview [Hub Generated]
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 engagement record.
- Link to engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [ ] a public preview
- [ ] GA release
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.
- Design Document:
- Previous Open API Doc:
- Updated paths:
❔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.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
Hi, @john35452 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 10 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| search.json | 2022-12-01-preview(2b28c3e) | 2022-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 13 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-12 | package-preview-2022-12(2b28c3e) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L433 |
|
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L474 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L474 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L474 |
|
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L541 |
|
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L588 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L588 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L588 |
|
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L595 |
|
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L636 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L636 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L636 |
|
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2022-12-01-preview/search.json#L988 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-12-01-preview/search.json#L280 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L426 |
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L426 |
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L426 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Search/preview/2022-12-01-preview/search.json#L534 |
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Search/preview/2022-12-01-preview/search.json#L534 |
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Search/preview/2022-12-01-preview/search.json#L534 |
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L644 |
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L906 |
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L959 |
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Search/preview/2022-12-01-preview/search.json#L965 |
| :warning: PropertyDescription | Property should have a description. Location: Search/preview/2022-12-01-preview/search.json#L988 |
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2022-12-01-preview/search.json#L990 |
| :warning: PropertyDescription | Property should have a description. Location: Search/preview/2022-12-01-preview/search.json#L990 |
| :warning: PropertyDescription | Property should have a description. Location: Search/preview/2022-12-01-preview/search.json#L1076 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"\nfatal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/maps/data-plane/Search/readme.test.md', "errno":-2, "code":"ENOENT", "syscall":"open", "path":"/mnt/vss/_work/1/azure-rest-api-specs/specification/maps/data-plane/Search/readme.test.md"\n" |
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger pipeline restarted successfully, please wait for status update in this comment.
Hi @john35452, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.
Hi, @john35452. 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 no-recent-activity label.
Sorry for the last minute update. After discussion with our PM, we would like to change parameter location to coordinates to make the location pair input naming consistent among Azure Map APIs.
Hi, @john35452. 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 no-recent-activity label.
Hi, @john35452. 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.
Hi, @john35452. 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 no-recent-activity label.
Hi @john35452 This PR was flagged for attempting to introduce a new RP namespace to the main branch without first merging the new RP to the RPSaaSMaster branch. Please add the new RP in a merge to RPSaaSMaster before continuing the merge to main.
@mikekistler if this is good can you please update the appropriate labels?
Could I get one more API Steward to review/approve this PR? @markweitzel @JeffreyRichter @johanste @tg-msft @stewartadam ?
Could I get one more API Steward to review/approve this PR?
Wanted to ack this, won't be able to today but will get a review in tomorrow.
Really appreciate for the reviews from @mikekistler and @stewartadam . @jhendrixMSFT Could you help me to merge this PR? Thanks a lot for all your help here.