feat: API key and HTTP basic authentication support by halotukozak · Pull Request #24 · AVSystem/justworks

halotukozak · 2026-03-23T10:42:48Z

Summary

Add SecurityScheme sealed interface model (Bearer, ApiKey with header/query, Basic)
Extend SpecParser to extract securitySchemes from OpenAPI spec and resolve global security references
Dynamic applyAuth() generation in ApiClientBaseGenerator — conditional logic per scheme type
Security-aware constructor params in ClientGenerator — backward-compatible (token for single Bearer)
Wire spec files through JustworksSharedTypesTask for end-to-end security scheme generation
Lightweight SpecParser.parseSecuritySchemes() method for shared types task — avoids full spec re-parse

Test plan

SpecParserSecurityTest — 8 tests for scheme extraction (bearer, apiKey header/query, basic, filtering)
ApiClientBaseGeneratorTest — 24 tests including dynamic applyAuth for all scheme types
ClientGeneratorTest — 28 tests including security-aware constructors
JustworksPluginFunctionalTest — 2 functional tests for on-disk ApiClientBase with security
Backward compatibility: specs without security produce unchanged output

🤖 Generated with Claude Code

Copilot

Pull request overview

Adds first-class OpenAPI security scheme support (API key + HTTP Basic, alongside Bearer/backward-compat) to the parsing and codegen pipeline, and wires Gradle plugin shared-type generation to reflect spec-defined authentication.

Changes:

Introduces SecurityScheme / ApiKeyLocation in the core model and parses global securitySchemes + security usage from OpenAPI.
Generates auth-aware ApiClientBase.applyAuth() and security-aware client constructors (with backward-compat behavior for legacy Bearer-only usage).
Updates Gradle plugin to feed spec files into shared type generation; adds extensive unit + functional tests.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
plugin/src/main/kotlin/com/avsystem/justworks/gradle/JustworksSharedTypesTask.kt	Adds `specFiles` input and parses specs to drive shared `ApiClientBase` auth generation.
plugin/src/main/kotlin/com/avsystem/justworks/gradle/JustworksPlugin.kt	Wires each spec into the shared types task for security scheme extraction.
plugin/src/functionalTest/kotlin/com/avsystem/justworks/gradle/JustworksPluginFunctionalTest.kt	Functional coverage for security-aware vs backward-compatible `ApiClientBase`.
core/src/test/resources/security-schemes-spec.yaml	Fixture spec covering Bearer/apiKey/header+query/basic.
core/src/test/kotlin/com/avsystem/justworks/core/parser/SpecParserSecurityTest.kt	Unit tests for security scheme extraction/filtering.
core/src/test/kotlin/com/avsystem/justworks/core/gen/ClientGeneratorTest.kt	Constructor generation tests for various security scheme sets.
core/src/test/kotlin/com/avsystem/justworks/core/gen/ApiClientBaseGeneratorTest.kt	Tests for generated constructor params and `applyAuth()` body per scheme.
core/src/main/kotlin/com/avsystem/justworks/core/parser/SpecParser.kt	Extracts referenced security schemes from components + global security requirements.
core/src/main/kotlin/com/avsystem/justworks/core/model/ApiSpec.kt	Adds `SecurityScheme` model and `ApiSpec.securitySchemes`.
core/src/main/kotlin/com/avsystem/justworks/core/gen/Names.kt	Adds `BASE64_CLASS` for Basic auth generation.
core/src/main/kotlin/com/avsystem/justworks/core/gen/CodeGenerator.kt	Passes security schemes into shared-type generation.
core/src/main/kotlin/com/avsystem/justworks/core/gen/ClientGenerator.kt	Generates security-aware constructors and super-calls.
core/src/main/kotlin/com/avsystem/justworks/core/gen/ApiClientBaseGenerator.kt	Generates scheme-dependent auth params + dynamic `applyAuth()` implementation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

core/src/main/kotlin/com/avsystem/justworks/core/parser/SpecParser.kt

core/src/main/kotlin/com/avsystem/justworks/core/gen/shared/ApiClientBaseGenerator.kt

plugin/src/main/kotlin/com/avsystem/justworks/gradle/JustworksPlugin.kt

plugin/src/main/kotlin/com/avsystem/justworks/gradle/JustworksSharedTypesTask.kt

core/src/main/kotlin/com/avsystem/justworks/core/parser/SpecParser.kt

github-actions · 2026-03-24T09:58:40Z

Coverage Report

Overall Project	95.52% `-0.7%`	🍏
Files changed	91.82%	🍏

File	Coverage
Names.kt	100%	🍏
ArrowHelpers.kt	100%	🍏
ApiClientBaseGenerator.kt	100%	🍏
ClientGenerator.kt	99.64%	🍏
ApiSpec.kt	97.96%	🍏
ApiResponseGenerator.kt	92.99%	🍏
SpecParser.kt	92% `-2.6%`	❌
Issue.kt	90%	🍏
CodeGenerator.kt	85.16% `-6.25%`	❌

…tion Parse security schemes (Bearer, Basic, ApiKey) from OpenAPI specs and generate auth-aware ApiClientBase with corresponding constructor parameters and header/query injection. Wire spec files into JustworksSharedTypesTask for security scheme extraction. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

# Conflicts: # core/src/main/kotlin/com/avsystem/justworks/core/gen/ClientGenerator.kt # core/src/main/kotlin/com/avsystem/justworks/core/gen/CodeGenerator.kt # core/src/main/kotlin/com/avsystem/justworks/core/gen/shared/ApiClientBaseGenerator.kt # core/src/test/kotlin/com/avsystem/justworks/core/gen/ApiClientBaseGeneratorTest.kt # core/src/test/kotlin/com/avsystem/justworks/core/gen/ClientGeneratorTest.kt

Copilot

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

core/src/main/kotlin/com/avsystem/justworks/core/parser/SpecParser.kt

core/src/main/kotlin/com/avsystem/justworks/core/gen/CodeGenerator.kt

plugin/src/main/kotlin/com/avsystem/justworks/gradle/JustworksPlugin.kt

core/src/main/kotlin/com/avsystem/justworks/core/gen/shared/ApiClientBaseGenerator.kt

…d replace `warn` with `accumulate` - Replace mutable property list with direct property creation in `classBuilder`. - Remove redundant `warn` function and centralize warning handling using `accumulate`. - Update context receiver parameter names in `ArrowHelpers` for clarity. - Enforce non-null checks and ensure consistent warning accumulation in `SpecParser`.

…syntax - Move `primaryConstructor` invocation back to `classBuilder`. - Adjust context receiver parameter syntax for improved consistency and readability. - Ensure `securitySchemes` are deduplicated by name in `CodeGenerator`.

…ng security schemes - Delete unused `no securitySchemes` test in `ClientGeneratorTest`. - Add warning for conflicting security scheme types in `JustworksSharedTypesTask`.

…ey utilities

…cheme extraction Deduplicate SpecParser by extracting loadOpenApi() and parseSpec() helpers. Add parseSecuritySchemes() for lightweight extraction without full schema resolution. Make ParseResult generic to support both ApiSpec and List<SecurityScheme> results. Update JustworksSharedTypesTask to use the lightweight method, avoiding double full-parse of spec files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

# Conflicts: # core/src/main/kotlin/com/avsystem/justworks/core/gen/client/ClientGenerator.kt

…neration - Generate authentication handling for security schemes (Bearer, Basic, API Key). - Document security scheme support and configuration in README. - Refactor `ApiResponseGenerator` to include security scheme logic. - Update tests to validate security scheme handling.

Copilot AI review requested due to automatic review settings March 23, 2026 10:42

Copilot started reviewing on behalf of halotukozak March 23, 2026 10:43 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

halotukozak mentioned this pull request Mar 23, 2026

feat: sealed HttpError hierarchy with typed error bodies and HttpResult #25

Open

4 tasks

halotukozak force-pushed the feat/security-schemes branch from 0c0cb14 to 2cd275d Compare March 25, 2026 11:39

halotukozak requested a review from Copilot April 2, 2026 11:24

halotukozak self-assigned this Apr 2, 2026

Copilot started reviewing on behalf of halotukozak April 2, 2026 11:25 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

halotukozak and others added 6 commits April 2, 2026 13:47

refactor: remove redundant test case and add validation for conflicti…

b496517

…ng security schemes - Delete unused `no securitySchemes` test in `ClientGeneratorTest`. - Add warning for conflicting security scheme types in `JustworksSharedTypesTask`.

refactor(core, test): enhance security scheme handling and simplify k…

9273462

…ey utilities

Merge remote-tracking branch 'origin/master' into feat/security-schemes

cc2a256

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

halotukozak requested a review from mzielu April 2, 2026 16:07

halotukozak added this to the 0.0.2 milestone Apr 2, 2026

halotukozak requested review from MattK97 and removed request for mzielu April 7, 2026 12:20

halotukozak added 4 commits April 7, 2026 15:19

Merge branch 'master' into feat/security-schemes

d4ced5a

# Conflicts: # core/src/main/kotlin/com/avsystem/justworks/core/gen/client/ClientGenerator.kt

Merge branch 'master' into feat/security-schemes

4b76891

# Conflicts: # core/src/main/kotlin/com/avsystem/justworks/core/gen/client/ClientGenerator.kt

fmt

d385809

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: API key and HTTP basic authentication support#24

feat: API key and HTTP basic authentication support#24
halotukozak wants to merge 12 commits intomasterfrom
feat/security-schemes

halotukozak commented Mar 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 24, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

halotukozak commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

halotukozak commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 24, 2026 •

edited

Loading