Modify openapi & middleware to allow for optional auth#1275
Merged
jcscottiii merged 1 commit intomainfrom Mar 17, 2025
Merged
Conversation
jcscottiii
force-pushed
the
jcscottiii/optional-auth
branch
from
2c05288 to
2f661d3
Compare
jrobbins
approved these changes
Mar 14, 2025
Typically, you would set the security section to the following
to signal that endpoint can optionally take bearerAuth:
```
security:
- bearerAuth: []
- {}
```
But the current Go openapi library does not let us know that {} has been set.
As a result, this change sets a new security called `noAuth`. Now with
this new security parameter, it lets the server know that:
1. If the authorization header is provided, try to authenticate like normal, or
2. If the authorization header is not set and this new noAuth option is a possibility
for the route, treat it like an unauthenticated request that should proceed.
The GCIP middleware has been modified to fit that logic.
This is needed for the get_saved_search endpoint.
Other changes:
- Have the getSavedSearch endpoint use the new noAuth config
- Fix other openapi lint errors.
jcscottiii
force-pushed
the
jcscottiii/optional-auth
branch
from
2f661d3 to
fa66304
Compare
Closed
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
2 participants
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.
Typically, you would set the security section to the following to signal that endpoint can optionally take bearerAuth:
But the current Go openapi library does not let us know that {} has been set.
As a result, this change sets a new security called
noAuth. Now with this new security parameter, it lets the server know that:The GCIP middleware has been modified to fit that logic.
This is needed for the get_saved_search endpoint.
Other changes: