10000 app: Add logic to handle $ref in parameters BNCH-125141 BNCH-125943 by peter-goldstein · Pull Request #231 · benchling/openapi-python-client · GitHub
[go: up one dir, main page]
Skip to content

app: Add logic to handle $ref in parameters BNCH-125141 BNCH-125943 #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
May 27, 2025
Merged

app: Add logic to handle $ref in parameters BNCH-125141 BNCH-125943 #231

merged 11 commits into from
May 27, 2025

Conversation

peter-goldstein
Copy link

The following is valid in the openapi spec:

paths:
  foos:
    get:
      parameters:
      - $ref: '#/components/parameters/barParam'

components:
  parameters:
    barParam:
      example: baz
      in: query
      name: bar
      schema:
        type: string

In December of 2020, when we diverged from the upstream branch, the client generator could not yet handle $ref in the parameters list. They added that feature in August 2022 but we never pulled it in.

In this PR, I try to pull in the same implementation from the upstream while modifying our repo as little as possible. Only the tests are really hand-written.

Testing

  • Update unit tests
  • Apply to our spec and see the missing $ref defined parameters in the generated methods

@peter-goldstein
Minimal changes to enable debugging
19b63ca
@peter-goldstein
Improve configuration for vscode development
1c41e40 
- Set ruler to 120 characters, which is the configured value in black
- Set up vscode to use pytest with the same configuration as task unit
- Turn off mypy in tests. They are so noncompliant that it's useless
@peter-goldstein
Copy ParameterError from upstream
d7fdb6e
@peter-goldstein
Copy ClassName from upstream
06bfd85
@peter-goldstein
Copy parameter reference handling from upstream
68821b5 
This builds a library of parameter references from the openapi spec and
gives a utility for looking them up.
@peter-goldstein
Copy build_parameters from upstream
ef98975 
This builds the actual Parameters object from the OpenAPI spec, using
the logic we just added to schemas.
@peter-goldstein
Copy parameter reference logic from upstream
aeeee23 
Intead of ignoring reference-typed parameters, look them up in the
Parameters object.
@peter-goldstein
Update unit tests
eac03e9
@peter-goldstein
Update version to 1.0.7
85f2b42
@peter-goldstein
Remove explicit local python interpreter
2a7ce4d
@peter-goldstein
Format launch.json
37d6a1a
@peter-goldstein peter-goldstein merged commit 5bbcc23 into prod/1.x May 27, 2025
@peter-goldstein peter-goldstein mentioned this pull request Jun 2, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@peter-goldstein
0