OAI / OAI/OpenAPI-Specification

Callbacks runtime expressions in multipart bodies

Abierto
#2,146 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

links media and encoding question
Lenguaje dominante
Markdown
Estrellas
31.2k
Forks
9.2k
Merge medio
6 h 37 min
PR fusionados (30 d)
27

Descripción

Hi,
In the OpenAPI spec, when defining a Callback Object, you can use a runtime expression in the form of:

$request.body#...

What goes after "body" should be a JSON pointer expression.

However, when the HTTP request contains a multipart body, I fail to see how to reference a specific body part, where the JSON pointer expression is to be applied.

Any hint on how to express this in OpenAPI?

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 con las secciones enlazadas Callback Object y runtime expressions de OpenAPI 3.0.2; después, compara su definición de $request.body con los cuerpos de solicitud multipart. Determina si se puede acceder a una parte multipart mediante la forma existente de JSON Pointer; se considera terminado cuando la especificación documenta claramente la expresión compatible o identifica el cambio necesario en la especificación.

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
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.