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

Aperta
#5,861 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia con l’esempio in #/components/examples/list-attestations-bulk/value e confronta attestations_subject_digests con gli schemi dei due percorsi POST interessati. Verifica se la struttura a oggetto o ad array è quella autorevole, quindi fai in modo che lo schema e l’esempio concordino per entrambi gli endpoint. Il lavoro è terminato quando l’esempio documentato è valido rispetto a entrambi gli schemi interessati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Nessun dato sulla lingua
Stelle
1.6k
Fork
342
Merge medio
3h 33m
PR unite (30g)
51

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/rest-api-description

Tutte le issue di github/rest-api-description

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.