[BUG][RUBY-NEXTGEN] Array query parameters are always sent as name[]=, ignoring style and explode

Abierto
#25,715 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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
Stack tecnológico
java, ruby

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=b
  • style: form, explode: false should be one comma-separated value: ?flatTags=a,b
  • style: spaceDelimited should be ?spaceTags=a%20b
  • style: pipeDelimited should 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

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 OpenAPITools/openapi-generator

Todos los issues de OpenAPITools/openapi-generator

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.