FunctionDeclarationSchemaProperty interface

結構定義用於定義輸入/輸出資料的格式。代表 OpenAPI 3.0 結構定義物件的一部分。日後可視需求新增更多欄位。

簽名：

export interface FunctionDeclarationSchemaProperty 

屬性

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

函式宣告結構定義屬性.description

選用設定。屬性的說明。

簽名：

description?: string;

函式 DeclarationSchemaProperty.enum

選用設定。屬性的列舉。

簽名：

enum?: string[];

函式宣告結構定義屬性.example

選用設定。屬性範例。

簽名：

example?: unknown;

函式宣告結構定義屬性.format

選用設定。屬性的格式。

簽名：

format?: string;

函式宣告結構定義屬性.items

選用設定。屬性的項目。FunctionDeclarationSchema

簽名：

items?: FunctionDeclarationSchema;

函式宣告結構定義屬性.nullable

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

簽名：

nullable?: boolean;

函式宣告結構定義屬性

選用設定。FunctionDeclarationSchema 的對應。

簽名：

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

FunctionDeclarationSchemaProperty.required

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

簽名：

required?: string[];

函式宣告結構定義屬性.type

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

簽名：

type?: FunctionDeclarationSchemaType;