OpenAPITools / OpenAPITools/openapi-generator
[REQ][OCaml] Support `securitySchemes` (or at the very least, additional header list)
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
Often, Open API specs contain a securitySchemes component (https://swagger.io/docs/specification/v3_0/authentication/) for authentication.
It would be great if the generated OCaml code supported passing authentication data (e.g., the Authorization header).
As a simpler but still quite useful alternative, if all endpoints accepted an optional list of header names and values, one could "easily" pass ~additional_headers:[("Authorization", "Bearer <token>")].
Describe the solution you'd like
Ability to pass authentication data.
Describe alternatives you've considered
Currently I have to copy the generated code to add those authentication headers 😢
Additional context
N/A.
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 by locating the OCaml generator and its generated endpoint functions, then trace how OpenAPI securitySchemes are represented. Compare the requested authentication support with the simpler additional-headers alternative. Done means generated OCaml clients can pass authentication data, or optional headers, with coverage for the supported behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml, openapi
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100