[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1search~1issues/get`

オープン 初心者向け
#6,233 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
68/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
openapi
領域
api

調査の方向性

GET パス参照 #/paths/~1search~1issues/get と例 #/components/examples/issue-search-result-item-paginated-lexical-fallback/value から始めます。例の items エントリを #/components/schemas/issue-search-result-item と比較します。例とスキーマが、lexical fallback のレスポンスを含め、同じ構造を受け入れれば完了です。

索引モデルが issue の本文から書いたものです。

説明

feature

Schema Inaccuracy

This is the JSON ref for the example

#/components/examples/issue-search-result-item-paginated-lexical-fallback/value

Schema and example mismatch. items is supposed to be of type #/components/schemas/issue-search-result-item but the example contains a String with ellipsis.

Here's a snippet

    1: {
    2:   "incomplete_results" : false,
>   3:   "items" : [ "..." ],
    4:   "lexical_fallback_reason" : [ "quoted_text" ],
    5:   "search_type" : "lexical",
    6:   "total_count" : 280
    7: }

Affected Schema Refs

#/paths/~1search~1issues/get

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
  • ghes-3.16
  • ghes-3.17
  • ghes-3.18
  • ghes-3.19
  • ghes-3.20
主要言語
言語のデータがありません
スター
1.6k
フォーク
342
平均マージ
3時間 33分
マージ済み PR（30日）
51

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/rest-api-description のほかの issue

github/rest-api-description の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。