OpenAPITools / OpenAPITools/openapi-generator
[BUG] [Elixir] Invalid client module names generated from Paypal API spec
Nobody has claimed this yet.
- 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)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
When generating an Elixir client using Paypal's OpenAPI spec files, invalid module names are sometimes created. This prevents the application from compiling.
Actual: defmodule Orders.Model.400DetailsInner do
Expected: uncertain.
- Every part of a module name separated by a
.must begin with an upper-case letter. So, prefixing the400DetailsInnerportion with something arbitrary likeXwould work:defmodule Orders.Model.X400DetailsInner do. - Alternatively, module names are just atoms that start with
Elixir.Creating modules (and referencing them throughout the code base) like this should work::"Elixir.Orders.Model.400DetailsInner" - There may be another, better solution that I'm not thinking of.
openapi-generator version
latest
OpenAPI declaration file content or url
https://github.com/paypal/paypal-rest-api-specifications/blob/main/openapi/checkout_orders_v2.json
Generation Details
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:latest generate \
-i /local/checkout_orders_v2.json \
-g elixir \
-o /local/out/
Steps to reproduce
git clone git@github.com:paypal/paypal-rest-api-specifications.gitcd paypal-rest-api-specifications/openapi- Run the above generation command
less out/lib/orders/model/_400_details_inner.ex- Observe invalid module definition:
defmodule Orders.Model.400DetailsInner do
Related issues/PRs
Suggest a fix
See above.
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
Reproduce generation with the Paypal checkout_orders_v2.json spec and the shown Docker command. Inspect out/lib/orders/model/_400_details_inner.ex and the generated references to determine a valid Elixir module name. Done means the generated client uses valid module definitions and compiles successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir, openapi
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100