FunctionDeclarationSchemaProperty interface

架构用于定义输入/输出数据的格式。表示 OpenAPI 3.0 架构对象的选定子集。未来可能会根据需要添加更多字段。

签名

export interface FunctionDeclarationSchemaProperty 

属性

属性 类型 说明
description 字符串 可选。属性的说明。
枚举 字符串[] 可选。属性的枚举。
示例 未知 可选。属性的示例。
格式 字符串 可选。属性的格式。
items FunctionDeclarationSchema 可选。房源的项。FunctionDeclarationSchema
可为 null 布尔值 可选。属性是否可为 null。
属性 { [k: string]: FunctionDeclarationSchema;} 可选。FunctionDeclarationSchema 的映射。
required 字符串[] 可选。必需属性数组。
type FunctionDeclarationSchemaType 可选。属性的类型。FunctionDeclarationSchemaType

FunctionDeclarationSchemaProperty.description

可选。属性的说明。

签名

description?: string;

FunctionDeclarationSchemaProperty.enum

可选。属性的枚举。

签名

enum?: string[];

FunctionDeclarationSchemaProperty.example

可选。属性的示例。

签名

example?: unknown;

FunctionDeclarationSchemaProperty.format

可选。属性的格式。

签名

format?: string;

FunctionDeclarationSchemaProperty.items

可选。房源的项。FunctionDeclarationSchema

签名

items?: FunctionDeclarationSchema;

FunctionDeclarationSchemaProperty.nullable

可选。属性是否可为 null。

签名

nullable?: boolean;

FunctionDeclarationSchemaProperty.properties

可选。FunctionDeclarationSchema 的映射。

签名

properties?: {
        [k: string]: FunctionDeclarationSchema;
    };

FunctionDeclarationSchemaProperty.required

可选。必需属性数组。

签名

required?: string[];

FunctionDeclarationSchemaProperty.type

可选。属性的类型。FunctionDeclarationSchemaType

签名

type?: FunctionDeclarationSchemaType;