[typespec-next] React to azure/typespec-azure#3180 #24561
Merged
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
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| generated.json | 2023-06-01-preview(480dccf) | 2023-06-01-preview(main) |
| generated.json | 2022-12-01(480dccf) | 2022-12-01(main) |
| generated.json | 2023-05-15(480dccf) | 2023-05-15(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| release_2022_12_01_autogen | release_2022_12_01_autogen(480dccf) | release_2022_12_01_autogen(typespec-next) |
| release_2023_05_15_autogen | release_2023_05_15_autogen(480dccf) | release_2023_05_15_autogen(typespec-next) |
| release_2023_06_01_preview_autogen | release_2023_06_01_preview_autogen(480dccf) | release_2023_06_01_preview_autogen(typespec-next) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Avoid the use of x-nullable. Location: inference/preview/2023-06-01-preview/generated.json#L387 |
||
| Avoid the use of x-nullable. Location: inference/preview/2023-06-01-preview/generated.json#L591 |
||
| Avoid the use of x-nullable. Location: inference/stable/2022-12-01/generated.json#L242 |
||
| Avoid the use of x-nullable. Location: inference/stable/2022-12-01/generated.json#L446 |
||
| Avoid the use of x-nullable. Location: inference/stable/2023-05-15/generated.json#L293 |
||
| Avoid the use of x-nullable. Location: inference/stable/2023-05-15/generated.json#L497 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Security definition should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L46 |
|
| Security definition should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L51 |
|
| OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L64 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L70 |
|
| Parameter should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L77 |
|
| OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L115 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L121 |
|
| Parameter should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L128 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: inference/preview/2023-06-01-preview/generated.json#L165 |
|
| OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L166 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L172 |
|
| Parameter should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L179 |
|
| OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L217 |
|
| Parameter should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L223 |
|
| OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L268 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L274 |
|
| Schema name should be Pascal case. Location: inference/preview/2023-06-01-preview/generated.json#L311 |
|
| Schema name should be Pascal case. Location: inference/preview/2023-06-01-preview/generated.json#L346 |
|
| Schema name should be Pascal case. Location: inference/preview/2023-06-01-preview/generated.json#L359 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: inference/preview/2023-06-01-preview/generated.json#L505 |
|
| Avoid the use of x-nullable. Location: inference/preview/2023-06-01-preview/generated.json#L585 |
|
| Avoid the use of x-nullable. Location: inference/preview/2023-06-01-preview/generated.json#L685 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: inference/preview/2023-06-01-preview/generated.json#L774 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: inference/preview/2023-06-01-preview/generated.json#L804 |
|
| Schema should have a description or title. Location: inference/preview/2023-06-01-preview/generated.json#L1110 |
|
| Security definition should have a description. Location: inference/stable/2022-12-01/generated.json#L46 |
|
| Security definition should have a description. Location: inference/stable/2022-12-01/generated.json#L51 |
|
| OperationId should be of the form 'Noun_Verb' Location: inference/stable/2022-12-01/generated.json#L64 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/stable/2022-12-01/generated.json#L70 |
|
| Parameter should have a description. Location: inference/stable/2022-12-01/generated.json#L77 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️❌TypeSpecAPIView: 0 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️❌TypeSpec Validation: 3 Errors, 6 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"details":"The generated swagger file 2023-06-01-preview/generated.json from typespec specification/cognitiveservices/OpenAI.Inference is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The generated swagger file 2022-12-01/generated.json from typespec specification/cognitiveservices/OpenAI.Inference is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The generated swagger file 2023-05-15/generated.json from typespec specification/cognitiveservices/OpenAI.Inference is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L200 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L164 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L200 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L164 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L200 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L164 |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Hi, @mikeharder 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 Generation Artifacts
|
Generated ApiView
|
mikeharder
commented
Jun 23, 2023
specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp
Outdated
Show resolved
Hide resolved
|
Hi @mikeharder! The automation detected breaking changes in this pull request. As a result, it added the |
timotheeguerin
approved these changes
Jun 23, 2023
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 PR includes changes reacting to the fix for Azure/typespec-azure#3180