プロパティタブで設定できる内容について説明します。
リソース画面のプロパティタブにはテーブルに含まれているプロパティ一覧が表示されます。
各プロパティ右端の編集ボタンからプロパティ設定を編集できます。
プロパティは以下の項目が編集可能です。
- 論理名: プロパティについて分かりやすい名前を設定できます。論理名はOpenAPIドキュメントにも表示されます。
- 説明: プロパティについて、詳細な情報を記載できます。
- バリデーション設定: プロパティをAPIリクエストに含めたときに実行するバリデーションチェックを設定できます。以下の画像だとAddressは100文字以内にする必要があります。
- メソッド別必須項目: POST, PUT リクエスト実行時にプロパティを必須にするか設定できます。以下の画像だとAddressはPOSTリクエストで必須、PUTリクエストでは任意になります。
- 条件付き必須項目: プロパティをAPIリクエストに含めたとき、他のプロパティを必須にするか設定できます。以下の画像だとリクエストにAddressが含まれているときNameもリクエストに含める必要があります。
