OAI / OAI/OpenAPI-Specification

Share header with multiple response objects

Ouverte
#369 13 commentaires 13 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

re-use: globals/defaults
Langage dominant
Markdown
Étoiles
31.2k
Forks
9.2k
Merge moyen
6 h 37 min
PR mergées (30 j)
27

Description

Can there not just be a simple header generically at the response level not specific to each of the status codes? For our case, this kind of header is 99% the same across our codebase.


---

responses:
  200:
    description: no error
    headers:
      Content-Type:
        description: application/json
        type: string

It would be a pain to copy+paste this to each and every routine that supports HTTP JSON responses.

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.

Piste de recherche

Commencez par lire les règles relatives à l'objet de réponse dans le dépôt OpenAPI Specification et comparez la manière dont les en-têtes sont actuellement définis sous les différents codes d'état. Définissez la portée et la structure valides d'un en-tête partagé au niveau de la réponse, puis mettez à jour le texte pertinent de la spécification et les exemples afin que le comportement de la fonctionnalité soit sans ambiguïté.

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

Évaluation

Stack technique
openapi
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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