Skip to content

Allow ApiKeyAuth generation when an "apiKey" security scheme is present in the spec#10708

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
NightEule5:fix_apikeyauth_omission
Nov 2, 2021
Merged

Allow ApiKeyAuth generation when an "apiKey" security scheme is present in the spec#10708
wing328 merged 1 commit intoOpenAPITools:masterfrom
NightEule5:fix_apikeyauth_omission

Conversation

@NightEule5
Copy link
Copy Markdown
Contributor

@NightEule5 NightEule5 commented Oct 27, 2021 •
edited
Loading

Fixes #10679 by generating ApiKeyAuth when an "apiKey" security scheme is present in the spec.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Nov 2, 2021

Thanks for the PR.

cc @jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03)

@wing328
Copy link
Copy Markdown
Member

wing328 commented Nov 2, 2021

Did a local test and confirmed the generation of the said file when API key authentication is defined in the schema:

[main] INFO  o.o.codegen.TemplateManager - writing file /tmp/kotlin3/src/main/kotlin/org/openapitools/client/auth/ApiKeyAuth.kt
[main] INFO  o.o.codegen.TemplateManager - writing file /tmp/kotlin3/.openapi-generator-ignore
[main] INFO  o.o.codegen.TemplateManager - writing file /tmp/kotlin3/.openapi-generator/VERSION
[main] INFO  o.o.codegen.TemplateManager - writing file /tmp/kotlin3/.openapi-generator/FILES

@wing328 wing328 merged commit 60bc508 into OpenAPITools:master Nov 2, 2021
@wing328 wing328 added this to the 5.3.1 milestone Nov 2, 2021
@NightEule5 NightEule5 deleted the fix_apikeyauth_omission branch November 3, 2021 05:43
ashutoshgngwr added a commit to ashutoshgngwr/openapi-generator that referenced this pull request Jan 12, 2022
@ashutoshgngwr
fix incorrect ApiKeyAuth import in jvm-retrofit2 kotlin-client template
b7e23c2 
links to
- OpenAPITools#10008
- OpenAPITools#10708
@ashutoshgngwr ashutoshgngwr mentioned this pull request Jan 12, 2022
Merged
5 tasks
wing328 pushed a commit that referenced this pull request Jan 12, 2022
@ashutoshgngwr
Fix missing ApiKeyAuth import in 'jvm-retrofit2' Kotlin client templa…
1bfed46 
…te (#11286)

* fix incorrect ApiKeyAuth import in jvm-retrofit2 kotlin-client template

links to
- #10008
- #10708

* update kotlin-retrofit2 samples
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

Client: Kotlin Issue: Bug

Projects

None yet

Milestone

5.3.1

Development

Successfully merging this pull request may close these issues.

[BUG] [Kotlin] [Gradle Plugin] ApiKeyAuth is not generated under jvm-retrofit2 when no "oauth2" security scheme is present in the spec

2 participants

@NightEule5 @wing328