Conversation
|
Hi, @seanmcc-msft 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 |
|---|---|---|
| file.json | 2023-01-03(02ec353) | 2022-11-02(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L46:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L93:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L164:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L240:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L313:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L491:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L566:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L689:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L804:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L927:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1047:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1175:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1271:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1334:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1419:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1516:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1607:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1671:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1762:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1853:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L1952:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2077:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2190:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2265:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2420:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2517:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2630:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2724:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L2826:9 |
|
| The new version is removing enum value(s) '2022-11-02' from the old version. Old: Microsoft.FileStorage/preview/2022-11-02/file.json#L3002:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-01 | package-2023-01(02ec353) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Property should have a description. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L5982 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
HostParametersValidation |
The host parameter must be called 'endpoint'. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L16 |
HostParametersValidation |
The host parameter must be typed 'type 'string', format 'url''. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L16 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L135 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L145 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L221 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L361 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L366 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L371 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L376 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L387 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L547 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L644 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L670 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L759 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L785 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L882 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L908 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1002 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1028 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1080 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1130 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1156 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1239 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1249 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1390 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1400 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1487 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1497 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1578 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.FileStorage/preview/2023-01-03/file.json#L1588 |
️️✔️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: 0 Errors, 0 Warnings failed [Detail]
️️✔️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. |
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
|
@tg-msft, could you help get this merged? |
|
Hi, @seanmcc-msft, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This is not a breaking change
This is a new feature in a new service version.
This is not a breaking change