公開コードリポジトリの issue、マージ済みのプルリクエスト、README に加え、厳選されたドキュメントサイトを検索します。結果は関連度順に表示され、一致した本文箇所が Markdown 形式で含まれます。
配列フィルターを JSON として渡す場合は、同じパスで POST を使用できます。
繰り返し可能なフィルターは、GET でどちらの形式も受け付けます。types=issue&types=pull_request のように query パラメータを繰り返す形式、または types=issue,pull_request のようにカンマ区切りの 1 つの値を指定する形式です。
repos と sources による検索範囲の制限#
インデックスは2つの部分に分かれており、これら2つのフィルターはそれぞれ独立して検索範囲を制限します。
reposはリポジトリ側、つまりissue、pull_request、readmeタイプの範囲を制限しますsourcesはドキュメント側、つまりdocタイプの範囲を制限します- 両方を指定すると、2つの部分は共通部分ではなく結合されるため、いずれかから一致する結果が返されます
各フィルターは片方の部分にのみ適用されるため、指定されたどのタイプにも一致し得ないフィルターは、何も返さずに処理されるのではなく拒否されます。
typesにリポジトリタイプが含まれない状態でreposを指定すると、400が返され、reposが要求されたどのタイプにも一致できないこと、およびリポジトリタイプを追加するかreposを外す必要があることが報告されますtypesにdocが含まれない状態でsourcesを指定すると、400が返され、sources cannot match any requested type; add doc or drop sourcesとなります
リポジトリフィルターによる検索範囲の制限#
7 つのリポジトリフィルター (language (Rust など) 、topic (async など) 、license (MIT など) 、min_stars、max_stars、archived、fork) は、コードリポジトリの属性を表します。インデックス内のドキュメントページの大半は、リポジトリに紐付かないクロール済み Web サイトから取得されています。そのため、リポジトリの属性でそのようなページを含めたり除外したりすることはできません。
したがって、これらのフィルターのいずれかを指定し、sources で範囲を指定しないリクエストでは、doc の結果は返されません。インデックスのドキュメント側は実行されないため、レスポンスに含まれるのはリポジトリの根拠のみ、すなわち issue、pull_request、readme タイプです。これは仕様であり、インデックスの不具合ではありません。
ドキュメント結果を取得するには、リポジトリフィルターを削除してください。また、sources でドキュメント側の範囲を指定し、レスポンス内の sources エコーを確認して ID がインデックス化されていることを確認することもできます。
sources に指定できる値#
sources は固定の列挙型ではありません。ドキュメントのソース ID を受け付けます。各 ID は最大 512 文字の空でない文字列で、1 リクエストあたり最大 20 個指定できます。ID はインデックス内のドキュメントサイトを示しており、その一覧は随時追加されます。
ID が解決されることを確認するには、その ID を渡し、レスポンスに追加される sources 配列を確認します。この配列は sources を送信した場合にのみ含まれ、指定した各 ID と、その ID がインデックス化されているかどうかをリクエスト時のまま返します。
indexed: true は、ソースに公開済みの世代があることを示し、そのソースのドキュメントの根拠が表示される場合があります。indexed: false は、その ID に一致するものがないことを示します。これにより、インデックスに存在しない ID と、単に何も見つからなかった query を区別できます。
repos も同様に返され、indexed と types 配下のタイプ別内訳を含む repos 配列として返されます。
ワークフローの概要については、Developer Index ガイドを参照してください。