[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1codespaces~1secrets/get`

オープン
#5,624 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

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

調査の方向性

エンドポイントリファレンス #/paths/1repos1{owner}~1{repo}1codespaces1secrets/get と、例のリファレンス #/components/examples/repo-codespaces-secret-paginated/value から始めます。スキーマと例の secrets エントリを比較し、visibility に重点を置きます。このレスポンスについて、fpt と ghec の両方でスキーマと例が一致すれば完了です。

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

説明

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/repo-codespaces-secret-paginated/value

The field visibility doesn't exist in the schema, but exists in the example.

Here's a snippet

    2:   "secrets" : [ {
    3:     "name" : "GH_TOKEN",
    4:     "created_at" : "2019-08-10T14:59:22Z",
    5:     "updated_at" : "2020-01-10T14:59:22Z",
>   6:     "visibility" : "all"
    7:   }, {
    8:     "name" : "GIST_ID",
    9:     "created_at" : "2020-01-10T10:59:22Z",
   10:     "updated_at" : "2020-01-11T11:59:22Z",

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
主要言語
言語のデータがありません
スター
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 を短くまとめたダイジェスト。