OpenAPITools / OpenAPITools/openapi-generator
[BUG] Kotlin multiplatform requires auth methods
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)?
- 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 generating a new client with the kotlin generator and the multiplatform library, if your spec has no api endpoints that require any authentication methods, the generated client will have errors and a private authentications property will be generated with lazy instantiation block of:
{
mapOf()
}
openapi-generator version
4.3.1
OpenAPI declaration file content or url
Works with any declaration that contains zero authorizations: arrays.
Command line used for generation
openapi-generator generate -g kotlin --library multiplatform -o kotlin_client -i test.yaml
Steps to reproduce
- Grab a valid openapi spec with no
authorizationsfor any endpoints - Generate a kotlin multiplatform client
- Try to build a native library from the generated client code, e.g.:
./gradlew clean jvmJar
Related issues/PRs
Suggest a fix
I submitted a PR to fix the issue. More work regarding the kotlin mutliplatform library needs to be done for sure though: https://github.com/OpenAPITools/openapi-generator/pull/6983
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 Kotlin multiplatform generation command and a valid OpenAPI spec containing no authentication requirements. Build the generated client with ./gradlew clean jvmJar and inspect the generated private authentications property and its lazy mapOf() block. Done means a no-authentication specification produces a client that builds successfully; PR #6983 is linked as prior work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin, openapi
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100