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

Minor fix the missing parameters for ingestion API #27364

Merged
merged 2 commits into from
Jan 16, 2024

chunk size

319b085
Select commit
Loading
Failed to load commit list.
Merged

Minor fix the missing parameters for ingestion API #27364

chunk size
319b085
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jan 12, 2024 in 3m 3s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
release_2023_10_01_preview release_2023_10_01_preview(319b085) release_2023_10_01_preview(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ ParameterNamesConvention header parameter name 'storageEndpoint' should be kebab case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L1207
⚠️ ParameterNamesConvention header parameter name 'embeddingDeploymentName' should be kebab case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L1213


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

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/2023-10-01-preview/azureopenai.json#L10
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L10
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L31
⚠️ Formdata Check for appropriate use of formData parameters.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L60
⚠️ Formdata Check for appropriate use of formData parameters.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L85
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L94
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L107
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L132
⚠️ ParameterNamesConvention Parameter name 'file-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L134
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L150
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L173
⚠️ ParameterNamesConvention Parameter name 'file-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L175
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L188
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L214
⚠️ ParameterNamesConvention Parameter name 'file-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L216
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L232
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L274
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L287
⚠️ PageableOperation Based on the response model schema, operation 'FineTunes_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L302
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L302
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L323
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L363
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L376
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L404
⚠️ ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L406
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L422
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L445
⚠️ ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L447
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L460
⚠️ PageableOperation Based on the response model schema, operation 'FineTunes_GetEvents' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L475
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L475
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L486
⚠️ ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L488
⚠️ 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/2023-10-01-preview/azureopenai.json#L493
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L510
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L535
⚠️ ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L537
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L553
⚠️ PageableOperation Based on the response model schema, operation 'FineTuning_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L568
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L568
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L603
⚠️ Post201Response Using post for a create operation is discouraged.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L643
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L656
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L681
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L683
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L699
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L722
⚠️ ParameterNamesConvention Parameter name 'fine-tuning-job-id' should be camel case.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L724
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L737
⚠️ PageableOperation Based on the response model schema, operation 'FineTuning_GetEvents' might be pageable. Consider adding the x-ms-pageable extension.
Location: authoring/preview/2023-10-01-preview/azureopenai.json#L752
View more details on openapi-pipeline-app