Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive security authentication support to the OpenAPI specification library. The changes enable the swagger_ui to properly add authorization headers to "try it out" requests by implementing the OpenAPI 3.0 security specification.
- Adds security scheme definitions and global security requirements to the OpenAPI struct
- Implements helper methods for common authentication types (API key, Bearer token, Basic auth, OAuth2, OpenID Connect)
- Provides functionality to manage security requirements at the global level
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| security.go | New file containing security-related methods and functionality for managing authentication schemes |
| openapi.go | Updated OpenAPI struct to include Security field and added SecurityScheme, Flows, and Flow type definitions |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jbsmith7741
reviewed
Jul 16, 2025
Member
jbsmith7741
left a comment
There was a problem hiding this comment.
Would you
- Update the docs/chart.drawio.svg graph to show the new security components.
- Add unit tests around the changes to verify those sections are generated as expected.
- Update the readme and/or add examples on how to use these new methods.
- This should include how someone bypasses auth for certain endpoints. Say those that don't need authentication.
jbsmith7741
approved these changes
Jul 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added Security objects to the openapi spec.
This allows for the swagger_ui to properly add authorization headers to "try it out" requests.