データ型属性を使用 - Cloud

[Name] (名前)

データ型名またはプロパティ名。

データ型またはプロパティ定義のルートエレメント。

[Description] (説明)

プロパティの説明。

説明

必須の有無

ブール値。プロパティが必須かどうかを定義します。

• OAS 3.0とSwagger 2.0: 必須であるプロパティは、オブジェクトレベルでrequiredエレメントにリスト表示されます。
• RAML: required

制限

リクエスト、レスポンスまたは両方でプロパティを使用できるかどうかを定義します。

• OAS 3.0: プロパティにブール値を使うwriteOnlyエレメントまたはreadOnlyエレメントを指定できます。
• Swagger 2.0またはRAML 1.0には、対応するエレメントがありません。

例

プロパティのサンプル値。APIモックを使う場合は返されます。

• OAS 3.0とSwagger 2.0: [example] (サンプル)エレメントで一番目の値が使用されます。その他の値は無視されます。
  注: OAS 3.0仕様にはexamplesエレメントが含まれていますが、Talend Cloud API Designerではサポートされていません。
• RAML: examples

[Additional Properties] (追加のプロパティ)

ブール値。データ型定義に含まれていないプロパティタイプをオブジェクトが受け入れるかどうかを定義します。これはデフォルトで有効になっています。

additionalProperties

[Min items] (アイテムの最小数)と[Max items] (アイテムの最大数)

配列内のアイテムの最小数と最大数。

minItemsとmaxItems

[Unique items] (一意のアイテム)

ブール値。配列内の各アイテムが一意である必要があるかどうかを定義します。

• OAS 3.0とRAML 1.0: uniqueItems
• Swagger 2.0には、対応するエレメントがありません。

[Enum] (列挙型)

プロパティの可能な値。

enum

[Min length] (最小長)と[Max length] (最大長)

値のバイトの最小数と最大数。

minLengthとmaxLength

パターン

値が一致するべき正規表現。

パターン

デフォルト

値がない場合に使う値。

デフォルト

[Enum] (列挙型)

プロパティの可能な値。

enum

[Format] (形式)

数字または整数に使う形式。

format

[Minimum] (最小値)と[Maximum] (最大値)

数字または整数の最小値と最大値。

[Minimum] (最小値)と[Maximum] (最大値)

デフォルト

値がない場合に使う値。

デフォルト

[Enum] (列挙型)

プロパティの可能な値。

enum

デフォルト

値がない場合に使う値。

デフォルト

[Enum] (列挙型)

プロパティの可能な値。

enum

[Format] (形式)

日時に使う形式。

• RAML 1.0: format
• OAS 3.0: OAS 3.0の日時のプロパティは、date-timeという形式の文字列として定義されています。デフォルトで使われる日時形式はRFC3339ですが、rfc2616が選択されている場合はdate-time-rfc2616というカスタム形式が使われます。
• Swagger 2.0: 日時のプロパティはOAS 3.0の場合と同様に定義されていますが、Swagger 2.0ではカスタム形式がサポートされていません。選択された形式にかかわらず、RFC3339として解釈されます。

[Min length] (最小長)と[Max length] (最大長)

値のバイトの最小数と最大数。

minLengthとmaxLength

[File types] (ファイルタイプ)

*/*という形式で使うファイルのタイプ。例: image/png

• RAML 1.0: fileTypes