Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add authentication for haskell-servant #12470

Merged
merged 2 commits into from
May 26, 2022

Conversation

7omb
Copy link
Contributor

@7omb 7omb commented May 26, 2022

Adds support for API key, basic and bearer authentication in the OpenAPI specification. OAuth and multiple authentication schemes simultaneously are not implemented. The implementation uses servants generalized authentication.

If the OpenAPI specification does not specify an authentication mechanism it is compatible with the existing implementation. I added examples without authentication and for the different schemes here. The command:

./mvnw integration-test -f ./samples/server/petstore/haskell-servant/pom.xml

passes on my machine with BUILD SUCCESS.

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 (6.0.1) (patch release), 6.1.x (breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • 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
Member

wing328 commented May 26, 2022

Tests are good.

openapi-petstore> configure (lib)
Configuring openapi-petstore-0.1.0.0...
openapi-petstore> build (lib)
Preprocessing library for openapi-petstore-0.1.0.0..
Building library for openapi-petstore-0.1.0.0..
[1 of 2] Compiling OpenAPIPetstore.Types
[2 of 2] Compiling OpenAPIPetstore.API
openapi-petstore> copy/register
Installing library in /Users/williamcheng/Code/openapi-generator2/samples/server/petstore/haskell-servant/.stack-work/install/x86_64-osx/d7eaccd255e546d469fd16f5af3892ff7caa92ed8e070d4c3bfe612e97b830c4/9.0.2/lib/x86_64-osx-ghc-9.0.2/openapi-petstore-0.1.0.0-4YkDtr09w237nRoGp23ALC
Registering library for openapi-petstore-0.1.0.0..
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:15 min
[INFO] Finished at: 2022-05-26T23:43:31+08:00
[INFO] ------------------------------------------------------------------------

@wing328 wing328 merged commit 54dca39 into OpenAPITools:master May 26, 2022
@wing328 wing328 added this to the 6.0.0 milestone May 26, 2022
@7omb
Copy link
Contributor Author

7omb commented May 26, 2022

Thank you, that was quick!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants