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.

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

Minor Fixes of TypeSpec for AOAI On Your Data 2023-12-01-preview /extensions/chat/completions #27271

Merged
merged 9 commits into from
Jan 10, 2024

generated

52d5824
Select commit
Loading
Failed to load commit list.
Merged

Minor Fixes of TypeSpec for AOAI On Your Data 2023-12-01-preview /extensions/chat/completions #27271

generated
52d5824
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jan 9, 2024 in 3m 16s

Swagger LintDiff succeeded

Details

compared tags (via openapi-validator v2.1.6) new version base version
release_2023_08_01_preview_autogen release_2023_08_01_preview_autogen(52d5824) release_2023_08_01_preview_autogen(main)

The following errors/warnings exist before current PR submission:

Rule Message
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/preview/2023-08-01-preview/generated.json#L689
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/preview/2023-08-01-preview/generated.json#L760
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/preview/2023-08-01-preview/generated.json#L1126
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/preview/2023-08-01-preview/generated.json#L1710
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L46
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L51
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/preview/2023-08-01-preview/generated.json#L64
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/preview/2023-08-01-preview/generated.json#L70
⚠️ ParameterDescription Parameter should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L77
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/preview/2023-08-01-preview/generated.json#L115
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/preview/2023-08-01-preview/generated.json#L121
⚠️ ParameterDescription Parameter should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L128
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: inference/preview/2023-08-01-preview/generated.json#L165
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/preview/2023-08-01-preview/generated.json#L166
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/preview/2023-08-01-preview/generated.json#L172
⚠️ ParameterDescription Parameter should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L179
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/preview/2023-08-01-preview/generated.json#L217
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/preview/2023-08-01-preview/generated.json#L223
⚠️ ParameterDescription Parameter should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L230
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: inference/preview/2023-08-01-preview/generated.json#L266
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/preview/2023-08-01-preview/generated.json#L268
⚠️ ParameterDescription Parameter should have a description.
Location: inference/preview/2023-08-01-preview/generated.json#L274
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/preview/2023-08-01-preview/generated.json#L320
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/preview/2023-08-01-preview/generated.json#L326
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: inference/preview/2023-08-01-preview/generated.json#L363
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: inference/preview/2023-08-01-preview/generated.json#L397
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: inference/preview/2023-08-01-preview/generated.json#L410
⚠️ 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: inference/preview/2023-08-01-preview/generated.json#L502
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: inference/preview/2023-08-01-preview/generated.json#L639
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L734
⚠️ PropertyType Property should have a defined type.
Location: inference/preview/2023-08-01-preview/generated.json#L814
⚠️ 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: inference/preview/2023-08-01-preview/generated.json#L872
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L900
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L933
⚠️ PropertyType Property should have a defined type.
Location: inference/preview/2023-08-01-preview/generated.json#L988
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L1017
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L1097
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L1107
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L1213
⚠️ Nullable Avoid the use of x-nullable.
Location: inference/preview/2023-08-01-preview/generated.json#L1225
⚠️ 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: inference/preview/2023-08-01-preview/generated.json#L1299
⚠️ 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: inference/preview/2023-08-01-preview/generated.json#L1328
⚠️ 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: inference/preview/2023-08-01-preview/generated.json#L1378
⚠️ PropertyType Property should have a defined type.
Location: inference/preview/2023-08-01-preview/generated.json#L1620