openapi-generators / openapi-generators/openapi-python-client
$ref in path parameters doesn't seem to work
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2k
- Forks
- 293
- Avg merge
- 34m
- Merged PRs (30d)
- 1
Description
Describe the bug
If a get path has a parameter using $ref to point to #/components/parameters, the generated API lacks the corresponding kwarg. If one "hoists" the indirect parameter up into the path's parameters, it works as expected.
To Reproduce
See this repo for a reproducible example.
And see this repo for the same schema without the $ref, working as expected.
Expected behavior
I expect to see the optional page kwarg in both generated APIs.
I see this in the $ref example:
def sync(
*,
client: Client,
) -> Optional[List[str]]:
and this in the noref example:
def sync(
*,
client: Client,
page: Union[Unset, None, GetTestPage] = UNSET,
) -> Optional[List[str]]:
OpenAPI Spec File
A link to your openapi.json which produces this issue.
Desktop (please complete the following information):
- OS: Microsoft Windows 10 Pro 10.0.19044 Build 19044
- Python Version: 3.9.12
- openapi-python-client version 0.11.1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked test-schema.yaml in the reproducible openapi-ref-issue repository and run the generator using the reported openapi-python-client version. Compare the generated sync entry point with the noref example, focusing on resolution of the parameter $ref. Done means the generated API includes the optional page kwarg in the referenced-parameter case as well.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100