Array of entities in request body
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
Línea de trabajo
Start in lib/grape-swagger/doc_methods/move_params.rb at MoveParams#build_definition, then read the related issue and the request-body examples. Compare the generated specification with Grape's requirement for an object containing the array under a top-level key. Done means the specification represents the intended JSON object without requiring a dummy optional parameter.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Related issue: https://github.com/ruby-grape/grape-entity/issues/252
As for example above, we want request body to be:
{
"accounts": [
{
"cma": 0,
"name": "string",
"environment": "string",
"sites": 0,
"username": "string",
"password": "string"
}
]
}
But actually:
[
{
"cma": 0,
"name": "string",
"environment": "string",
"sites": 0,
"username": "string",
"password": "string"
}
]
Grape also wants the array to be in the key of top level JSON object.
( Top level array data cannot be handled by Grape out of the box ( cf. https://github.com/ruby-grape/grape/issues/1730 ). )
So it seems the generated specification is broken.
A workaround is to adding dummy optional parameter.
It forces the request body to be a JSON object.
I've found that making MoveParams#build_definition to always use object_type fixes the issue.
Is this reasonable fix?
- Lenguaje dominante
- Ruby
- Estrellas
- 1.1k
- Forks
- 477
- Merge medio
- 5 h 25 min
- PR fusionados (30 d)
- 3
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ruby-grape/grape-swagger
-
Support default_response and default in 2.3; stop reading route.descPosiblemente ocupada @numbata la tomó hace 56 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
ruby-grape/grape-swagger#989 ·
Los mantenedores suelen responder en 1 día
-
Length limits (minLength/maxLength, minItems/maxItems) are dropped from body params moved into a definitionPosiblemente ocupada @numbata la tomó hace 7 días. Abierto
ruby-grape/grape-swagger#1010 · 1 comentario · 1 reacción · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
ruby-grape/grape-swagger#987 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
Bug report: omitted array parameters with `array_use_braces: true`Posiblemente ocupada @olivier-thatch la tomó hace 530 días. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
ruby-grape/grape-swagger#952 · 2 comentarios · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Bug Report: `default` for array params (`type: [String]`) is incorrectly placed inside `items`Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
ruby-grape/grape-swagger#950 · 2 comentarios · 1 reacción ·
Los mantenedores suelen responder en 1 día
Todos los issues de ruby-grape/grape-swagger
Issues similares
-
intercepted.rb crashes on an optional positional argument when the method also takes keywordsAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
yegor256/intercepted#128 ·
-
documentation good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
ysb3996-blip/oops#51 ·
Los mantenedores suelen responder en 1 día
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Remove leftover Cloud66 custom_web process from ProcfilePosiblemente ocupada @ShahadatTest la tomó hoy. AbiertoDifficulty: Easy Good First Issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
rubyforgood/casa#7330 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
area:core-lib P2 size:S
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día