properties

API での参照を行うためのプロパティーを定義するには、properties 拡張を使用します。

properties 拡張の構造は、以下のとおりです。

properties:
   property_1:
      value: default_value_1
      description: description_1
      encoded: encoded_boolean_1
   property_2
      value: default_value_2
      description: description_2
      encoded: encoded_boolean_2

以下の表に、properties 拡張内のフィールドを示します。

表 1. properties 拡張
プロパティー	必須	説明	データ型
`property`	はい	プロパティーの名前。プロパティーを参照する際に使用されます。これは、フィールドの内容ではなく、フィールドの名前であることに注意してください。	オブジェクト
`value`	いいえ	プロパティーのデフォルト値。空にすることができます。	ストリング
`description`	いいえ	プロパティーの説明。空にすることができます。	ストリング
`encoded`	いいえ	このプロパティーの値をエンコードするかどうかを指定します。	ブール

以下に、サンプルの properties フィールドを示します。

  properties:
    ID:
      value: 1234
      description: An ID to be used for validating.
      encoded: false

最終更新: 2017 年 10 月 31 日