[BUG][RUBY-NEXTGEN] Array query parameters are always sent as name[]=, ignoring style and explode
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 72/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Domaine
- backend-api-design
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Java
- Étoiles
- 26.9k
- Forks
- 7.8k
- Merge moyen
- 2 j 23 min
- PR mergées (30 j)
- 177
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OpenAPITools/openapi-generator
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25768 ·
Les mainteneurs répondent en général sous 1 jour
-
Enhancement: Feature
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25753 ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
OpenAPITools/openapi-generator#25724 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25723 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePeut-être pris @Inf1mum l’a pris il y a 2 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25719 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OpenAPITools/openapi-generator
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
eclipse-tradista/tradista#371 ·
Les mainteneurs répondent en général sous 1 jour
-
Failed to start Rescue missionOuvertecritical
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
mars-sim/mars-sim#2199 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
primefaces/primefaces#15568 ·
Les mainteneurs répondent en général sous 1 jour
-
崩溃日志只按 CRLF 分行Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
PCL-Community/PCL-CE#3872 ·
Les mainteneurs répondent en général sous 1 jour