Add api version 2024-02-15-preview of Azure OpenAI #27669
Merged
openapi-pipeline-app / Swagger LintDiff
succeeded
Feb 8, 2024 in 2m 46s
Swagger LintDiff succeeded
Details
| compared tags (via openapi-validator v2.1.7) | new version | base version |
|---|---|---|
| release_2024_02_15_preview | release_2024_02_15_preview(4930863) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'FineTuning_List' might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L341 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L341 |
||
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L376 |
||
| Using post for a create operation is discouraged. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L416 |
||
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L429 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L454 |
||
| Parameter name 'fine-tuning-job-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L456 |
||
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L472 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L495 |
||
| Parameter name 'fine-tuning-job-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L497 |
||
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L510 |
||
| Based on the response model schema, operation 'FineTuning_GetEvents' might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L525 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L525 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L535 |
||
| Parameter name 'fine-tuning-job-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L537 |
||
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L567 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L592 |
||
| Parameter name 'fine-tuning-job-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L594 |
||
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L610 |
||
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L732 |
||
| Property should have a defined type. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L1216 |
||
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L1236 |
||
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L1257 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Based on the response model schema, operation 'Files_List' might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L10 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L10 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L65 |
|
| Check for appropriate use of formData parameters. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L94 |
|
| Check for appropriate use of formData parameters. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L124 |
|
| Using post for a create operation is discouraged. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L133 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L146 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L171 |
|
| Parameter name 'file-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L173 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L189 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L212 |
|
| Parameter name 'file-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L214 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L227 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L253 |
|
| Parameter name 'file-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L255 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L271 |
|
| Using post for a create operation is discouraged. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L313 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L326 |
|
| Based on the response model schema, operation 'Models_List' might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L625 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L625 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L646 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: authoring/preview/2024-02-15-preview/azureopenai.json#L671 |
|
| Parameter name 'model-id' should be camel case. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L673 |
|
| Error response should contain a x-ms-error-code header. Location: authoring/preview/2024-02-15-preview/azureopenai.json#L689 |
|
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L720 |
|
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L724 |
|
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L728 |
|
| 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: authoring/preview/2024-02-15-preview/azureopenai.json#L736 |
Loading