Schema（データ構造） | OpenAPI仕様ドキュメント（日本語版）

親操作に関連する可能性のある帯域外コールバックのマップ。マップ内の各値は、API プロバイダーによって開始される可能性のある一連の要求と予期される応答を記述するパス項目オブジェクトです。パス項目オブジェクトを識別するために使用されるキー値は、実行時に評価される式であり、コールバック操作に使用する URL を識別します。

Exampleオブジェクト

固定フィールド

Linkオブジェクト

Linkオブジェクトは、応答に対する可能な設計時のリンクを表します。リンクの存在は、呼び出し元がリンクを正常に呼び出すことができることを保証するものではなく、応答と他の操作の間の既知の関係およびトラバーサルメカニズムを提供します。

Headerオブジェクト

ヘッダーオブジェクトは、パラメーターオブジェクトの構造に従いますが、次の変更があります。

Tagオブジェクト

Operation Objectによって使用される単一のタグにメタデータを追加します。操作オブジェクトインスタンスで定義されたタグごとにタグオブジェクトを持つことは必須ではありません。

Referenceオブジェクト

OpenAPI ドキュメント内の他のコンポーネントを内部および外部から参照できるようにする単純なオブジェクトです。

Schemaオブジェクト

Schemaオブジェクトを使用すると、入力データ型と出力データ型を定義できます。これらの型はオブジェクトである場合もありますが、プリミティブや配列である場合もあります。このオブジェクトは、JSON スキーマ仕様ドラフト 2020-12のスーパーセットです。

識別子オブジェクト

リクエストの本文またはレスポンスのペイロードが多数の異なるスキーマの 1 つである場合、discriminatorオブジェクトを使用してシリアル化、逆シリアル化、および検証を支援できます。識別子は、スキーマ内の特定のオブジェクトであり、それに関連付けられた値に基づいて、ドキュメントの消費者に代替スキーマを通知するために使用されます。

XMLオブジェクト

より微調整された XML モデル定義を可能にするメタデータオブジェクト。

Security Schemeオブジェクト

操作で使用できるセキュリティスキームを定義します。

OAuth Flowsオブジェクト

サポートされている OAuth フローの構成を許可します。

Security Requirementオブジェクト

この操作を実行するために必要なセキュリティスキームをリストします。各プロパティに使用される名前は、コンポーネントオブジェクトのセキュリティスキームで宣言されたセキュリティスキームに対応する必要があります。