swagger-api / swagger-api/swagger-codegen

[python][Bug] Snake convertion issue with OAS3.0

Open
#10,276 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

I have a query-param values named device.groups, deviceGroups these are different query-params under a query-params x. When swagger-codegen generate SDK, these two are converted to device_groups(Snake case). This is causing duplicate keyword argument error in init of the query-param.

Swagger-codegen version

3.0.20

Swagger declaration file content or url
"device.groups": {
      "type": "string"
}
"deviceGroups": {
      "type": "string"
}
Command line used for generation

swagger-codegen generate -i {spec_path} -l python -o {output_location}

Steps to reproduce

Define query-param values as above in a simple openapi-spec and run swagger-codegen

Related issues/PRs
Suggest a fix/enhancement

Converting everything to snake-case will cause errors(Eventhough it is the python standard)

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 issue with the supplied OpenAPI declaration and the swagger-codegen Python command. Trace the Python SDK parameter-name conversion, then verify that device.groups and deviceGroups remain distinct and no duplicate keyword argument is generated.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.