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

Aperta Adatta ai principianti
#6,233 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
68/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia dal riferimento al percorso GET #/paths/~1search~1issues/get e dall'esempio #/components/examples/issue-search-result-item-paginated-lexical-fallback/value. Confronta le voci items dell'esempio con #/components/schemas/issue-search-result-item; il lavoro è completato quando l'esempio e lo schema accettano la stessa struttura, inclusa la risposta di fallback lessicale.

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/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
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.