[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1enterprises~1{enterprise}~1settings~1billing~1budgets~1{budget_id}/patch`

Offen Anfängerfreundlich
#5,588 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
openapi
Bereich
api

Rechercherichtung

Beginne bei der PATCH-Operation für #/paths/1enterprises1{enterprise}1settings1billing1budgets1{budget_id}/patch und prüfe die Referenz #/components/examples/update-budget/value. Vergleiche das Feld budget_id des Beispiels mit dem Operationsschema und verifiziere anschließend, dass Schema und Beispiel synchron sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/update-budget/value

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

Here's a snippet

    1: {
>   2:   "budget_id" : "2c1feb79-3947-4dc8-a16e-80cbd732cc0b",
                       ^
    3:   "message" : "Budget successfully updated."
    4: }

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghec
Vorherrschende Sprache
Keine Sprachdaten
Sterne
1.6k
Forks
342
Ø Merge
3 Std. 33 Min.
Gemergte PRs (30 T.)
51

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/rest-api-description

Alle Issues in github/rest-api-description

Ähnliche Issues

Weitere Issues zu Backend & API Design

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.