Api key requests #6
Open
Conversation
This file contains 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
Added control of env variables on compile time. Hierarchy changes to split the code
gbm25
added
enhancement
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.
Important Changes
The following are the most significant changes:
Request Headers
Requests must now include an "x-api-key" header with a valid value to access resources.
If the request lacks this header, includes multiple headers, or has an incorrect value, a custom error will be returned.
Code Organization
main.rshas been moved. A new module has been created to better organize endpoints and Rocket's request guards.Environment Variables
Additional dependencies have been added to simplify the use of environment variables.
To keep the
x-api-keyhidden, you must create an.envfile with aAPI_KEYset to the correct value in local/development environments.Future Use
The code is intended for later use in conjunction with GitHub Action and GitHub secrets.
Before Merging
Please note: These changes should not be merged until the client-side (Flutter app) has been updated to include the
x-api-keyin requests.