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

Ouverte Adaptée aux débutants
#5,588 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
72/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
openapi
Domaine
api

Piste de recherche

Commencez par l’opération PATCH de #/paths/1enterprises1{enterprise}1settings1billing1budgets1{budget_id}/patch et examinez la référence #/components/examples/update-budget/value. Comparez le champ budget_id de l’exemple avec le schéma de l’opération, puis vérifiez que le schéma et l’exemple sont synchronisés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
Aucune donnée de langage
Étoiles
1.6k
Forks
342
Merge moyen
3 h 33 min
PR mergées (30 j)
51

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/rest-api-description

Toutes les issues de github/rest-api-description

Issues similaires

Plus d'issues Backend & API Design

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.