スキーマのローカライズ

スキーマ定義ファイルは、REST API とそのエンドポイントの動作を定義します。また、API 定義ドキュメントも提供します。これは API 定義ファイル内の情報で、ユーザーが API 機能について理解を深めるのに役立ちます。

例えば、common_pl-1.0.schema.json ファイルで定義されたスキーマの 1 つとして Activity スキーマがあります。その定義には、次の description プロパティが含まれています。

"description": "An `Activity` is an assignable item that represents a task to be done, a
            decision to be made, or information to be aware of"

Cloud API で /openapi.json エンドポイントと /swagger.json エンドポイントを使用する場合、API 定義ドキュメントは応答に含まれます。ユーザーは、この情報を Swagger UI などの API 定義ツールを通して、またはルールエディタ内のコンテキストヘルプなどの他のコンテキストで直接表示できます。同じ REST API で作業している別のユーザーが別の言語で作業することもできます。 そのため、Guidewire REST API フレームワーク（およびそのフレームワーク上に置かれている Cloud API）は、スキーマ定義ドキュメントをローカライズする機能をサポートしています。この機能は、「スキーマローカリゼーション」と漠然と呼ばれています。

このトピックでは、ロケール固有のテキストをスキーマ定義ドキュメントに追加する方法について説明します。