[BUG][RUBY-NEXTGEN] Array query parameters are always sent as name[]=, ignoring style and explode
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 72/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Área
- backend-api-design
Línea de trabajo
Start by reading the ruby-nextgen generator's api_operations.mustache and Configuration#encode_array, then compare its generated query handling with the parameter style and explode values in the reproduction. Check the ruby-nextgen tests for query parameter serialization and add coverage for repeated, comma, space, and pipe delimiters. Done means generated clients serialize each array according to its OpenAPI declaration.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
Description
ruby-nextgen sends every array query parameter as name[]=a&name[]=b, whatever its style/explode. api_operations.mustache passes the Array under its parameter name, Configuration#encode_array leaves it untouched for the default query_array_encoding = :repeat, and Faraday's default encoder adds the brackets.
style: form, explode: true(the default) should repeat the name:?tags=a&tags=bstyle: form, explode: falseshould be one comma-separated value:?flatTags=a,bstyle: spaceDelimitedshould be?spaceTags=a%20bstyle: pipeDelimitedshould be?pipeTags=a|b
query_array_encoding = :csv does give tags=a,b, but it is a client-wide setting: it applies to every array parameter and ignores what each one declares.
openapi-generator version
master, 7.28.0-SNAPSHOT, 8a9fb722777e770e2c44b20b00bddbb51a0d525a
OpenAPI declaration file content or url
openapi: 3.0.3
info:
title: array query parameters
version: 1.0.0
paths:
/things:
get:
operationId: listThings
parameters:
- name: tags
in: query
schema:
type: array
items:
type: string
- name: flatTags
in: query
style: form
explode: false
schema:
type: array
items:
type: string
- name: spaceTags
in: query
style: spaceDelimited
explode: false
schema:
type: array
items:
type: string
- name: pipeTags
in: query
style: pipeDelimited
explode: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
Generation Details
java -jar openapi-generator-cli.jar generate -g ruby-nextgen -i spec.yaml -o out \
--additional-properties=gemName=petstore,moduleName=Petstore
Steps to reproduce
$LOAD_PATH.unshift 'out/lib'
require 'petstore'
# Answers every request with 200 and prints the URL it would have gone out with.
class Capture < Faraday::Middleware
def call(env)
puts URI.decode_www_form_component(env.url.to_s)
env.status = 200; env.body = ''; env.response_headers = Faraday::Utils::Headers.new
env.response = Faraday::Response.new(env)
end
end
client = Petstore::Client.new(base_url: 'http://localhost') { |c| c.use(Capture) }
client.things.list(tags: %w[a b])
client.things.list(flat_tags: %w[a b])
client.things.list(space_tags: %w[a b])
client.things.list(pipe_tags: %w[a b])
Actual (ruby 4.0.9, faraday 2.15.1):
http://localhost/things?tags[]=a&tags[]=b
http://localhost/things?flatTags[]=a&flatTags[]=b
http://localhost/things?spaceTags[]=a&spaceTags[]=b
http://localhost/things?pipeTags[]=a&pipeTags[]=b
Expected:
http://localhost/things?tags=a&tags=b
http://localhost/things?flatTags=a,b
http://localhost/things?spaceTags=a b
http://localhost/things?pipeTags=a|b
Related issues/PRs
- #24995 is the same defect for object query parameters.
- Lenguaje dominante
- Java
- Estrellas
- 26.9k
- Forks
- 7.8k
- Merge medio
- 2 d 23 min
- PR fusionados (30 d)
- 177
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una 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 OpenAPITools/openapi-generator
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OpenAPITools/openapi-generator#25768 ·
Los mantenedores suelen responder en 1 día
-
Enhancement: Feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OpenAPITools/openapi-generator#25753 ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPosiblemente ocupada @Inf1mum la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
OpenAPITools/openapi-generator#25724 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPosiblemente ocupada @Inf1mum la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
OpenAPITools/openapi-generator#25723 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePosiblemente ocupada @Inf1mum la tomó hace 2 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
OpenAPITools/openapi-generator#25719 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de OpenAPITools/openapi-generator
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
eclipse-tradista/tradista#371 ·
Los mantenedores suelen responder en 1 día
-
Failed to start Rescue missionAbiertocritical
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
mars-sim/mars-sim#2199 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
primefaces/primefaces#15568 ·
Los mantenedores suelen responder en 1 día
-
崩溃日志只按 CRLF 分行Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
PCL-Community/PCL-CE#3872 ·
Los mantenedores suelen responder en 1 día