セキュリティフィルタリング

OpenAPI 仕様の一部のオブジェクトは、本質的に API ドキュメントの中核であるにもかかわらず、宣言されて空のままになったり、完全に削除されたりすることがあります (MAY)。

その理由は、ドキュメントに対するアクセス制御の追加レイヤーを許可するためです。仕様自体の一部ではありませんが、特定のライブラリは、何らかの形式の認証/認可に基づいてドキュメントの一部へのアクセスを許可することを選択してもよい(MAY)。

この 2 つの例:

1. Pathsオブジェクトは存在しても空であっても構いません。直感に反するかもしれませんが、これにより、視聴者は正しい場所に到達したが、ドキュメントにはアクセスできないことがわかります。これらのユーザーは、少なくとも認証に関する追加情報が含まれる可能性のある情報オブジェクトに引き続きアクセスできます。
2. パス項目オブジェクトは空であっても構いません。この場合、閲覧者はパスが存在することを認識しますが、その操作やパラメータを確認することはできません。これは、ユーザーがパスの存在を認識するため、パス自体をPaths オブジェクトから非表示にすることとは異なります。これにより、ドキュメントの提供者は、閲覧者に表示できる内容を細かく制御できるようになります。