discord api spec

Discord OpenAPI 仕様

このリポジトリには、Discord API の OpenAPI 3.1 仕様のパブリック プレビューが含まれています。現在、この仕様は最新の Discord API バージョン (v10) でのみ利用可能です。

️ OpenAPI 仕様のパブリック プレビューは、事前の通知なしに重大な変更が行われる可能性があるため、運用環境内では使用しないでください。

使用法

スペックファイル

標準仕様とプレビュー仕様の 2 つのバージョンの仕様が含まれています。

• openapi.json安定したパブリック API を含む標準仕様です。
• openapi_preview.jsonは、不安定な API 機能や実験的な API 機能を含むプレビュー仕様です。これは安定しているとはみなされず、運用環境で使用されるべきではありません。

Postman との統合

Postman で仕様を使用するには、パブリック コレクションを表示します。

貢献する

OpenAPI 仕様のコンテンツは自動的に生成されるため、このリポジトリへの一般公開は許可されていません。

?バグの修正や改善については、問題を開くことができます。

仕様の規約

• これはプレビューなので正しくない可能性があります。以下に記載するもの以外に、仕様とドキュメントの間に矛盾を見つけた場合は、仕様ではなくドキュメントに従ってください。
• anyOfおよびoneOf共用体を定義しても、それらはすべて、リスト内の 1 つの型のみをデータ形式として使用できることを意味します。たとえば、 anyOf: {'Cat', 'Dog'} 、 Cat+Dog DogではなくCatまたは Dog を渡すことができることを意味します。これは、カスタム拡張子x-discord-union: oneOfによって示されます。技術的にoneOf使用できない場合は、 anyOfを使用します。そうする理由の 1 つは、すべてのフィールドがオプションであり、渡されたデータが複数の形式で検証される可能性がある場合です。
• 応答フィールドの過剰な指定を避け、 int32などのフィールド タイプのみを定義し、特定の最小値や最大値などの定義を避けます。
• ドキュメント内で文字列として入力されている一部のフィールドは、仕様では int として入力される場合があります。私たちの API は、int として解析可能な場合、int フィールドの文字列を受け入れます。これらの int 解析可能な文字列を int として指定する方がより正確になると考えられます。

既知の問題

• (ほぼ) すべての NULL 可能フィールドが追加でオプションとしてマークされ、すべてのオプション フィールドが追加で NULL 可能としてマークされます。
• 操作とフィールドには説明がありません。
• オペレーションにはタグがありません。
• フラグ フィールドでは、特定のフラグ値とその意味については詳しく説明しません。
• あまり意味はありませんが、オプションのクエリ引数は null 許容として型指定されます。