schema.json ファイルの display key パターン
schema.json ファイルには、タイトルと説明という 2 つの基本的なタイプのドキュメントテキストが含まれています。これらは次の 4 つのレベルで宣言できます。
- API 自体
- API リソース
- API リソースのプロパティ
- API リソースの
additionalPropertiesプロパティ
スキーマのタイトルと説明
以下の display key は、スキーマのタイトルと説明に対応します。
json.<localizationPrefix>.titlejson.<localizationPrefix>.description
ベースコンフィギュレーションでは、この例がありません。
スキーマ定義のタイトルと説明
以下の display key は、各スキーマ定義のタイトルと説明に対応します。
json.<localizationPrefix>.definitions.<definitionName>.titlejson.<localizationPrefix>.definitions.<definitionName>.description
例えば、Common API の Activity スキーマ定義の description プロパティ（common_pl-1.0.schema.json で宣言）は、json.common.v1.definitions.Activity.description に対応します。
スキーマ定義プロパティのタイトルと説明プロパティ
以下の display key は、特定のスキーマ定義上の各プロパティのタイトルと説明に対応します。
json.<localizationPrefix>.definitions.<definitionName>.properties.<propertyName>.titlejson.<localizationPrefix>.definitions.<definitionName>.properties.<propertyName>.description
例えば、Common API の Activity スキーマ定義の activityType プロパティの description プロパティ（common_pl-1.0.schema.json で宣言）は、json.common.v1.definitions.Activity.properties.activityType.description に対応します。
スキーマ定義「additionalProperties」プロパティのタイトルと説明
以下の display key は、特定のスキーマ定義上の additionalProperties プロパティのタイトルと説明に対応します。
json.<localizationPrefix>.definitions.<definitionName>.additionalProperties.<propertyName>.titlejson.<localizationPrefix>.definitions.<definitionName>.additionalProperties.<propertyName>.description
例えば、Composite API の Headers スキーマ定義の additionalProperties の description プロパティ（composite_pl-1.0.schema.json で宣言）は、json.composite.v1.definitions.Headers.additionalProperties.description に対応します。