FunctionDeclarationSchemaProperty interface

「結構定義」可用來定義輸入/輸出資料的格式。代表 OpenAPI 3.0 結構定義物件的選取子集。日後可能會視需要新增更多欄位。

簽名：

export interface FunctionDeclarationSchemaProperty 

屬性

屬性	類型	說明
description	字串	選用設定。屬性的說明。
列舉	string[]	選用設定。屬性的列舉。
範例	不明	選用設定。屬性範例。
格式	字串	選用設定。屬性的格式。
items	FunctionDeclarationSchema	選用設定。房源的項目。FunctionDeclarationSchema
可為空值	布林值	選用設定。屬性是否可為空值。
資源	{ [k: string]: FunctionDeclarationSchema;}	選用設定。FunctionDeclarationSchema 的地圖。
必要	string[]	選用設定。必要屬性的陣列。
類型	FunctionDeclarationSchemaType	選用設定。屬性的類型。FunctionDeclarationSchemaType。

FunctionDeclarationSchemaProperty.description。

選用設定。屬性的說明。

簽名：

description?: string;

FunctionDeclarationSchemaProperty.列舉

選用設定。屬性的列舉。

簽名：

enum?: string[];

FunctionDeclarationSchemaProperty.example

選用設定。屬性範例。

簽名：

example?: unknown;

FunctionDeclarationSchemaProperty.format

選用設定。屬性的格式。

簽名：

format?: string;

函式宣告結構定義 Property.items

選用設定。房源的項目。FunctionDeclarationSchema

簽名：

items?: FunctionDeclarationSchema;

FunctionDeclarationSchemaProperty.nullable

選用設定。屬性是否可為空值。

簽名：

nullable?: boolean;

FunctionDeclarationSchemaProperty.properties

選用設定。FunctionDeclarationSchema 的地圖。

簽名：

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

FunctionDeclarationSchemaProperty.required

選用設定。必要屬性的陣列。

簽名：

required?: string[];

FunctionDeclarationSchemaProperty.type

選用設定。屬性的類型。FunctionDeclarationSchemaType。

簽名：

type?: FunctionDeclarationSchemaType;