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

オープン
#25,715 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
java, ruby

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Java
スター
26.9k
フォーク
7.8k
平均マージ
2日 23分
マージ済み PR(30日)
177

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenAPITools/openapi-generator のほかの issue

OpenAPITools/openapi-generator の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。