[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1users~1{username}~1attestations~1bulk-list/post`

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
openapi
領域
api

調査の方向性

#/components/examples/list-attestations-bulk/value の例から始め、attestations_subject_digests を影響を受ける2つの POST パスのスキーマと比較します。オブジェクト形式と配列形式のどちらが正式なものかを確認し、そのうえで両方のエンドポイントについてスキーマと例が一致するようにします。ドキュメント化された例が影響を受ける両方のスキーマに対して検証に合格すれば完了です。

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

説明

feature

Schema Inaccuracy

This is the JSON ref for the example

#/components/examples/list-attestations-bulk/value

Schema and example mismatch. The value for attestations_subject_digests is expected to be an object, but the example contains an array.

Here's a snippet

    1: {
>   2:   "attestations_subject_digests" : [ {
    3:     "sha256:abc" : [ {
    4:       "bundle" : {
    5:         "mediaType" : "application/vnd.dev.sigstore.bundle.v0.3+json",
    6:         "verificationMaterial" : {

Affected Schema Refs

#/paths/~1users~1{username}~1attestations~1bulk-list/post
#/paths/~1orgs~1{org}~1attestations~1bulk-list/post

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 を短くまとめたダイジェスト。