-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Creator to add version stable/2023-07-01 #24330
Conversation
Hi, @tejitpabari99 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 |
---|---|---|
wayfind.json | 2022-09-01-preview(40d6758) | 2022-09-01-preview(main) |
wayfind.json | 2023-03-01-preview(40d6758) | 2023-03-01-preview(main) |
Rule | Message |
---|---|
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Creator/preview/2022-09-01-preview/wayfind.json#L279:9 Old: Creator/preview/2022-09-01-preview/wayfind.json#L279:9 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Creator/preview/2022-09-01-preview/wayfind.json#L260:5 Old: Creator/preview/2022-09-01-preview/wayfind.json#L260:5 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Creator/preview/2023-03-01-preview/wayfind.json#L269:9 Old: Creator/preview/2023-03-01-preview/wayfind.json#L269:9 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Creator/preview/2023-03-01-preview/wayfind.json#L250:5 Old: Creator/preview/2023-03-01-preview/wayfind.json#L250:5 |
️⚠️
Breaking Change(Cross-Version): 9 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
alias.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
dataset.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
dwgconversion.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
features.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
featurestate.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
mapconfiguration.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
style.json | 2023-07-01(40d6758) | 2023-03-01-preview(main) |
tileset.json | 2023-07-01(40d6758) | 2023-03-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: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.3) | new version | base version |
---|---|---|
package-2023-07 | package-2023-07(40d6758) | default(main) |
package-preview-2023-03 | package-preview-2023-03(40d6758) | package-preview-2023-03(main) |
package-preview-2022-09 | package-preview-2022-09(40d6758) | package-preview-2022-09(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ValidFormats |
'file' is not a known format. Location: Creator/stable/2023-07-01/mapconfiguration.json#L212 |
ValidFormats |
'file' is not a known format. Location: Creator/stable/2023-07-01/style.json#L201 |
Based on the response model schema, operation 'Wayfinding_GetPath' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2022-09-01-preview/wayfind.json#L271 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2022-09-01-preview/wayfind.json#L271 |
|
A required parameter should not specify a default value. Location: Creator/preview/2022-09-01-preview/wayfind.json#L283 |
|
Error response should contain a x-ms-error-code header. Location: Creator/preview/2022-09-01-preview/wayfind.json#L318 |
|
The error property in the error response schema should be required.Location: Creator/preview/2022-09-01-preview/wayfind.json#L318 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2022-09-01-preview/wayfind.json#L318 |
|
Based on the response model schema, operation 'Wayfinding_GetPath' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/wayfind.json#L261 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/wayfind.json#L261 |
|
Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/wayfind.json#L308 |
|
The error property in the error response schema should be required.Location: Creator/preview/2023-03-01-preview/wayfind.json#L308 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2023-03-01-preview/wayfind.json#L308 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' 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/stable/2023-07-01/alias.json#L97 |
|
Using post for a create operation is discouraged. Location: Creator/stable/2023-07-01/alias.json#L115 |
|
Error response should contain a x-ms-error-code header. Location: Creator/stable/2023-07-01/alias.json#L127 |
|
The error property in the error response schema should be required.Location: Creator/stable/2023-07-01/alias.json#L127 |
|
Error schema should define code and message properties as required.Location: Creator/stable/2023-07-01/alias.json#L127 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' 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/stable/2023-07-01/alias.json#L134 |
|
Response body schema of pageable response should contain top-level array property value Location: Creator/stable/2023-07-01/alias.json#L155 |
|
Error response should contain a x-ms-error-code header. Location: Creator/stable/2023-07-01/alias.json#L159 |
|
The error property in the error response schema should be required.Location: Creator/stable/2023-07-01/alias.json#L159 |
|
Error schema should define code and message properties as required.Location: Creator/stable/2023-07-01/alias.json#L159 |
|
OperationId for put method should contain 'Create' or 'Update' Location: Creator/stable/2023-07-01/alias.json#L168 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' 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/stable/2023-07-01/alias.json#L168 |
|
'PUT' operation 'Alias_Assign' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/stable/2023-07-01/alias.json#L168 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/stable/2023-07-01/alias.json#L178 |
|
Error response should contain a x-ms-error-code header. Location: Creator/stable/2023-07-01/alias.json#L195 |
|
The error property in the error response schema should be required.Location: Creator/stable/2023-07-01/alias.json#L195 |
|
Error schema should define code and message properties as required.Location: Creator/stable/2023-07-01/alias.json#L195 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The JSON file has a circular reference. readme: maps/data-plane/Creator/readme.md json: Creator/stable/2023-07-01/tileset.json |
️️✔️
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
|
* updated minWIdth param default value and description * fixed spelling
* Remove alias from Style APIs and improve sprite description * Fix validation errors
* Dataset Swagger changes - Removing Udid support from GA * Changing version to 2023-07-01 in some places --------- Co-authored-by: tejitpabari@microsoft.com <tejitpabari@microsoft.com>
* Remove Wayfinding and Routeset from GA * Adding to Creator SDK readme * Revert "Adding to Creator SDK readme" This reverts commit b72f517. --------- Co-authored-by: tejitpabari@microsoft.com <tejitpabari@microsoft.com>
Hi @tejitpabari99! The automation detected breaking changes in this pull request. As a result, it added the |
…-07-01 (Azure#24330) * Adds base for updating Creator from version preview/2023-03-01-preview to version 2023-07-01 * Updates readme * Updates API version in new specs and examples * updated minWidth param default value and description (Azure#24385) * updated minWIdth param default value and description * fixed spelling * Remove alias from Style APIs and improve sprite description (Azure#24391) * Remove alias from Style APIs and improve sprite description * Fix validation errors * Dataset Swagger changes - Removing Udid support from GA (Azure#24358) * Dataset Swagger changes - Removing Udid support from GA * Changing version to 2023-07-01 in some places --------- Co-authored-by: tejitpabari@microsoft.com <tejitpabari@microsoft.com> * Remove Wayfinding and Routeset from GA (Azure#24468) * Remove Wayfinding and Routeset from GA * Adding to Creator SDK readme * Revert "Adding to Creator SDK readme" This reverts commit b72f517. --------- Co-authored-by: tejitpabari@microsoft.com <tejitpabari@microsoft.com> --------- Co-authored-by: davsta90 <88048110+davsta90@users.noreply.github.com> Co-authored-by: Xubin <zhugexubin@gmail.com> Co-authored-by: tejitpabari@microsoft.com <tejitpabari@microsoft.com>
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