スキーマは、入出力データの形式を定義するために使用されます。OpenAPI 3.0 スキーマ オブジェクトの選択サブセットを表します。今後、必要に応じてさらに項目が追加される可能性があります。
署名:
export interface FunctionDeclarationSchemaProperty
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
| description | 文字列 | 省略可。宿泊施設の説明。 |
| enum | string[] | 省略可。プロパティの列挙型。 |
| 例 | 不明 | 省略可。宿泊施設の例。 |
| 形式 | 文字列 | 省略可。プロパティの形式。 |
| items | FunctionDeclarationSchema | 省略可。宿泊施設のアイテム。FunctionDeclarationSchema |
| null 値許容 | boolean | 省略可。プロパティが null 値を許容するかどうか。 |
| プロパティ | { [k: string]: FunctionDeclarationSchema; } | 省略可。FunctionDeclarationSchema のマップ。 |
| required | string[] | 省略可。必須プロパティの配列。 |
| タイプ | 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;