Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add AOAI 2024-05-01-preview API version #29042

Merged
merged 5 commits into from
May 14, 2024

Update cSpell.json to override expected word;

8c0d7cd
Select commit
Failed to load commit list.
Merged

Add AOAI 2024-05-01-preview API version #29042

Update cSpell.json to override expected word;
8c0d7cd
Select commit
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff failed May 14, 2024 in 3m 48s

Swagger LintDiff failed

LintDiff: 23 Errors, 120 Warnings
View Azure DevOps build log for more details.

Details

[must fix]The following errors/warnings are introduced by current PR:
Only 50 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L1976
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2004
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2068
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2092
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2156
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2176
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2204
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2265
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2300
❌ UniqueXmsEnumName Must not have duplicate name of x-ms-enum extension , make sure every x-ms-enum name unique. The duplicate x-ms-enum name: datasourcetype, path: $['UserComputeDatasourceType']
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2338
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2375
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2411
❌ MissingTypeObject The schema 'ChunkingSettings' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2442
❌ MissingTypeObject The schema 'CrawlingSettings' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2451
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2572
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2596
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2615
❌ MissingTypeObject The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2634
❌ invalid-ref '#/definitions/OperationState' does not exist
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L2726
❌ AutoRest exception "tag":"release_2024_05_01_preview",
"details":"Schema violation: must be boolean (definitions > TargetType > x-ms-enum > modelAsString)"
❌ AutoRest exception "tag":"release_2024_05_01_preview",
"details":"Plugin 'schema-validator-swagger' completed with some error."
❌ AutoRest exception "tag":"release_2024_05_01_preview",
"details":"!Error: Plugin 'schema-validator-swagger' completed with some error."
❌ AutoRest exception "tag":"release_2024_05_01_preview",
"details":"Autorest completed with an error. If you think the error message is unclear,
or is a bug,
please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing."
⚠️ PageableOperation Based on the response model schema, operation 'FineTuning_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L346
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L346
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L381
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L421
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L434
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L459
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L461
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L477
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L500
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L502
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L515
⚠️ PageableOperation Based on the response model schema, operation 'FineTuning_GetEvents' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L530
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L530
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L540
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L542
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L572
⚠️ PageableOperation Based on the response model schema, operation 'FineTuning_GetCheckpoints' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L587
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L587
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L597
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L599
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L629
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L654
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L656
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L672
⚠️ PageableOperation Based on the response model schema, operation 'IngestionJobs_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L769
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L769
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L796


The following errors/warnings exist before current PR submission:

Rule Message
⚠️ PageableOperation Based on the response model schema, operation 'Files_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L10
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L10
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L65
⚠️ Formdata Check for appropriate use of formData parameters.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L94
⚠️ Formdata Check for appropriate use of formData parameters.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L129
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L138
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L151
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L176
⚠️ ParameterNamesConvention Parameter name 'file-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L178
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L194
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L217
⚠️ ParameterNamesConvention Parameter name 'file-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L219
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L232
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L258
⚠️ ParameterNamesConvention Parameter name 'file-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L260
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L276
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L318
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L331
⚠️ PageableOperation Based on the response model schema, operation 'Models_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L687
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L687
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L708
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L733
⚠️ ParameterNamesConvention Parameter name 'model-id' should be camel case.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L735
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2024-05-01-preview/azureopenai.json#L751
⚠️ EnumInsteadOfBoolean 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-05-01-preview/azureopenai.json#L1038
⚠️ EnumInsteadOfBoolean 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-05-01-preview/azureopenai.json#L1042
⚠️ EnumInsteadOfBoolean 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-05-01-preview/azureopenai.json#L1046
⚠️ EnumInsteadOfBoolean 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-05-01-preview/azureopenai.json#L1054
View more details on openapi-pipeline-app