[Hub Generated] Review request for Creator to add version preview/2022-09-01-preview #19889
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, @zhugexubin 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.9.6)] | new version | base version |
|---|---|---|
| tileset.json | 2022-09-01-preview(d5458bc) | 2.0(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 12 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-09 | package-preview-2022-09(d5458bc) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MapConfigurationModel'. Consider using the plural form of 'MapConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/mapconfiguration.json#L106 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MapConfigurationModel'. Consider using the plural form of 'MapConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/mapconfiguration.json#L150 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MapConfigurationModel'. Consider using the plural form of 'MapConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/mapconfiguration.json#L184 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MapConfigurationModel'. Consider using the plural form of 'MapConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/mapconfiguration.json#L226 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MapConfigurationModel'. Consider using the plural form of 'MapConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/mapconfiguration.json#L256 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StyleModel'. Consider using the plural form of 'Style' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/style.json#L106 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StyleModel'. Consider using the plural form of 'Style' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/style.json#L150 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StyleModel'. Consider using the plural form of 'Style' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/style.json#L184 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StyleModel'. Consider using the plural form of 'Style' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/style.json#L226 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StyleModel'. Consider using the plural form of 'Style' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/style.json#L256 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L245 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L278 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L106 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L150 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L184 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L215 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'TilesetModel'. Consider using the plural form of 'Tileset' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2022-09-01-preview/tileset.json#L320 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: maps/data-plane/Creator/readme.md json: Creator/preview/2022-09-01-preview/tileset.json |
️️✔️ApiReadinessCheck 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.
️⚠️SDK Track2 Validation: 4 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/d5458bc7e1d7906ef858f278d1c124c865400952/specification/maps/data-plane/Creator/readme.md#tag-package-preview-2022-09">maps/data-plane/Creator/readme.md#package-preview-2022-09
| Rule | Message |
|---|---|
| "readme":"maps/data-plane/Creator/readme.md", "tag":"package-preview-2022-09", "details":"Security scheme SharedKey is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"maps/data-plane/Creator/readme.md", "tag":"package-preview-2022-09", "details":"Security scheme SasToken is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"maps/data-plane/Creator/readme.md", "tag":"package-preview-2022-09", "details":"The schema 'MapConfiguration-styles' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/maps/data-plane/Creator/preview/2022-09-01-preview/mapconfiguration.json#/components/schemas/MapConfiguration-styles" |
|
| "readme":"maps/data-plane/Creator/readme.md", "tag":"package-preview-2022-09", "details":"The schema 'StyleObject-layers' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/maps/data-plane/Creator/preview/2022-09-01-preview/mapconfiguration.json#/components/schemas/StyleObject-layers" |
️️✔️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.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
Hi @zhugexubin, Your PR has some issues. Please fix the CI sequentially by following the order of
|
zhugexubin
requested review from
BlackRider97 and
bexxx
and removed request for
a team
|
This is the issue associated with this PR: #17312 |
|
@zhugexubin has the API review board been scheduled for this new version? |
@tjprescott We already finished the API review board process and fixed all the comments from the board there. |
|
#17312 This is the issue created with API Review board for the swagger changes. @tjprescott |
|
@zhugexubin I'm confused because this is the PR that issue links to: #18584 This API version is 8 months later. |
Right, since we decided to change public preview API version from 2022-01-01-preview to 2022-09-01-preview, that's why I created another PR for the new version. |
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
tjprescott
approved these changes
Aug 9, 2022
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 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