Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Length limits (minLength/maxLength, minItems/maxItems) are dropped from body params moved into a definition

Abierto
  • ¿Algo no está bien?
#1,010 1 comentario 1 reacción 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@numbata ya está trabajando en esto.

Desde el 26/10/2026.

  • #1011 de @numbata — abierto

Evaluación

Este issue todavía no se ha evaluado.

Descripción

Versions

grape-swagger 2.1.4 (the same code is on master).

What happens

https://github.com/ruby-grape/grape-swagger/pull/934 documents length: limits. That works for query and path params. For body params on POST/PUT/PATCH, DocMethods::MoveParams moves the params into a definition, and the limits are lost on the way:

  • MoveParams.property_keys copies a fixed list of keys, which doesn't include minLength / maxLength.
  • MoveParams.document_as_array builds the array property by hand (type, description, example, items), so minItems / maxItems are dropped.
Repro
require 'grape'
require 'grape-swagger'
require 'json'

class API < Grape::API
  format :json

  params do
    requires :name, type: String, length: { max: 50 }
    requires :tags, type: Array[String], length: { max: 3 }
  end
  post :things do; end

  add_swagger_documentation
end

env = Rack::MockRequest.env_for('/swagger_doc')
_status, _headers, body = API.call(env)
puts JSON.pretty_generate(JSON.parse(body.each.to_a.join)['definitions'])
Expected
"name": { "type": "string", "maxLength": 50 },
"tags": { "type": "array", "items": { "type": "string" }, "maxItems": 3 }
Actual
"name": { "type": "string" },
"tags": { "type": "array", "items": { "type": "string" } }
Possible workaround / fix

Prepending this makes the repro print the expected output:

module KeepLengthLimits
  private

  def property_keys
    super | %i[minLength maxLength]
  end

  def document_as_array(param)
    super.merge(param.slice(:minItems, :maxItems))
  end
end

GrapeSwagger::DocMethods::MoveParams.singleton_class.prepend(KeepLengthLimits)

A fix in the gem would probably be adding minLength / maxLength to property_keys and copying minItems / maxItems in document_as_array.

Lenguaje dominante
Ruby
Estrellas
1.1k
Forks
477
Merge medio
5 h 25 min
PR fusionados (30 d)
3

Preparar el entorno

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.

Más de ruby-grape/grape-swagger

Todos los issues de ruby-grape/grape-swagger

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.