Схема используется для определения формата входных/выходных данных. Представляет выбранное подмножество объекта схемы OpenAPI 3.0. При необходимости в будущем могут быть добавлены дополнительные поля.
Подпись:
export interface FunctionDeclarationSchemaProperty
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
| описание | нить | Необязательный. Описание объекта недвижимости. |
| перечисление | нить[] | Необязательный. Перечисление свойства. |
| пример | неизвестный | Необязательный. Пример объекта недвижимости. |
| формат | нить | Необязательный. Формат объекта недвижимости. |
| предметы | Объявление функцииСхема | Необязательный. Предметы имущества. Объявление функцииСхема |
| обнуляемый | логическое значение | Необязательный. Является ли свойство обнуляемым. |
| характеристики | { [k: строка]: FunctionDeclarationSchema ; } | Необязательный. Карта FunctionDeclarationSchema . |
| необходимый | нить[] | Необязательный. Массив требуемого свойства. |
| тип | ТипОбъявленияФункцииСхемы | Необязательный. Тип недвижимости. ТипОбъявленияФункцииСхемы . |
FunctionDeclarationSchemaProperty.description
Необязательный. Описание объекта недвижимости.
Подпись:
description?: string;
FunctionDeclarationSchemaProperty.enum
Необязательный. Перечисление свойства.
Подпись:
enum?: string[];
FunctionDeclarationSchemaProperty.example
Необязательный. Пример объекта недвижимости.
Подпись:
example?: unknown;
FunctionDeclarationSchemaProperty.format
Необязательный. Формат объекта недвижимости.
Подпись:
format?: string;
FunctionDeclarationSchemaProperty.items
Необязательный. Предметы имущества. Объявление функцииСхема
Подпись:
items?: FunctionDeclarationSchema;
FunctionDeclarationSchemaProperty.nullable
Необязательный. Является ли свойство обнуляемым.
Подпись:
nullable?: boolean;
FunctionDeclarationSchemaProperty.properties
Необязательный. Карта FunctionDeclarationSchema .
Подпись:
properties?: {
[k: string]: FunctionDeclarationSchema;
};
FunctionDeclarationSchemaProperty.required
Необязательный. Массив требуемого свойства.
Подпись:
required?: string[];
FunctionDeclarationSchemaProperty.type
Необязательный. Тип недвижимости. ТипОбъявлениеСхемыФункции .
Подпись:
type?: FunctionDeclarationSchemaType;