OAI / OAI/OpenAPI-Specification

Share header with multiple response objects

Abierto
#369 13 comentarios 13 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

re-use: globals/defaults
Lenguaje dominante
Markdown
Estrellas
31.2k
Forks
9.2k
Merge medio
6 h 37 min
PR fusionados (30 d)
27

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza leyendo las reglas del objeto de respuesta en el repositorio de OpenAPI Specification y compara cómo se definen actualmente los encabezados bajo códigos de estado individuales. Define el alcance y la estructura válidos para un encabezado compartido a nivel de respuesta y, a continuación, actualiza el texto relevante de la especificación y los ejemplos para que el comportamiento de la funcionalidad no sea ambiguo.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
openapi
Área
api
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.