OpenAPITools / OpenAPITools/openapi-generator

[BUG] OpenAPI code generator for k6 API load-testing tool does not work with deepObject

Open
#11,239 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

The K6 test generator does not support deepObject parameters. In the generated script it was added as ?filter=Array instead of expected: ?filter[foo]=bar

openapi-generator version

latest version 5.3.1

OpenAPI declaration file content
  • name: filter
    in: query
    description: Allows you to pass filtering options any attribute. ?filter[id]=123 or ?filter[author][like]=John. Example of accessing nested array values ?filter[tags.alias]=food
    required: false
    style: deepObject
    explode: true
    schema:
    type: object

@mostafa

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the k6 generator output with the OpenAPI declaration in the issue and compare its query serialization with the expected deepObject form. Trace the generator's parameter serialization entry point; done means nested filter parameters are emitted as filter[foo]=bar rather than filter=Array.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.