OpenAPITools / OpenAPITools/openapi-generator

[BUG] Python Client Code Regex `\n` Handle Problem

Open
#2,954 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

When try to generate python client from this Swagger file, it cannot handle parameter regex validation with \n.

openapi-generator version

4.0.0-beta3

OpenAPI declaration file content or url

https://gist.githubusercontent.com/wy193777/e2da6ad64259cc1ad6a672aae55b1d23/raw/f0ae7cf8bb36458298fd7e0e2ed1b099072d40d3/swagger.json

Command line used for generation

openapi-generator generate -i https://gist.githubusercontent.com/wy193777/e2da6ad64259cc1ad6a672aae55b1d23/raw/f0ae7cf8bb36458298fd7e0e2ed1b099072d40d3/swagger.json -g python -o code\jama-client --skip-validate-spec

Steps to reproduce

Generate client, then run tests.

Related issues/PRs
Suggest a fix

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 running the provided openapi-generator command with the linked Swagger file and inspect the generated Python client and its tests for the parameter regex containing \n. Compare the generated validation behavior with the declaration, then confirm the fix by regenerating the client and rerunning its tests without mishandling the regex.

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.