[BUG][RUBY-NEXTGEN] Array query parameters are always sent as name[]=, ignoring style and explode
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 72/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Lĩnh vực
- backend-api-design
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Java
- Star
- 26.9k
- Fork
- 7.8k
- Merge trung bình
- 2 ngày 23 phút
- Pull request đã merge (30 ngày)
- 177
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của OpenAPITools/openapi-generator
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Enhancement: Feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorCó thể đã có người làm @Inf1mum đã nhận 3 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
OpenAPITools/openapi-generator#25724 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayCó thể đã có người làm @Inf1mum đã nhận 3 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
OpenAPITools/openapi-generator#25723 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twiceCó thể đã có người làm @Inf1mum đã nhận 2 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
OpenAPITools/openapi-generator#25719 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của OpenAPITools/openapi-generator
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
eclipse-tradista/tradista#371 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Failed to start Rescue missionĐang mởcritical
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
mars-sim/mars-sim#2199 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
primefaces/primefaces#15568 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
崩溃日志只按 CRLF 分行Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
PCL-Community/PCL-CE#3872 ·
Maintainer thường phản hồi trong vòng 1 ngày