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.

Sign up for GitHub

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

Jump to bottom

Api creation #1

Merged
merged 48 commits into from
Nov 15, 2024
Merged

Api creation #1

merged 48 commits into from
Nov 15, 2024

Conversation

moonraker595
Copy link
Contributor

This pull request introduces the initial code for the Search API.

Key functionality includes:

  • connecting to an OpenSearch instance to pass the search query to
  • connecting to a Scigateway auth instance to verify the JWT
  • handling search requests through a /search endpoint
  • adding the appropriate filter to the search query, based on the investigations in the JWT metadata.

The stack can be started through the compose file.

@moonraker595
Checking jwt
4d21af2
@moonraker595
Config handling
94b924e
@moonraker595
Docker and compose file
3d6fcd1
@moonraker595
Basic readme
d115b37
@moonraker595
ingore
01a1730
@moonraker595
Handle investigations
58413fc
@moonraker595
Set up logging for the app
62bc055
@moonraker595
Added main endpoints
ae2c203
@moonraker595
Add test format
e62e957
@moonraker595
Added app requirements
474ee60
@moonraker595
Using default envs instead of .env file
46f2349
@moonraker595
Tidy up
dd2d1b3
@moonraker595
First pass at docker file
bf2b699
@moonraker595
Added OpenAPI spec
8f465d3
@moonraker595
Removed config.env
0d6c8cb
@moonraker595
now accepting any query and inserting filter
030e5af
@moonraker595
Tidy up
2675d62
@moonraker595
Tidy up
5b0d25a
@moonraker595
Readme
598eaf5
@moonraker595
Added cyptography for decoding jwts
08f16c1
@moonraker595
Added scigateway auth
fdd5f28
@moonraker595
Added example public key
5dd4ee5
@moonraker595
validating and decoding jwts
bd95f47
@moonraker595
Added custom filter
4420e40
@moonraker595
Re-jigged order
f012637
@moonraker595
Refactored to use fastapi's http bearer auth mechanism
68b4922
@moonraker595
Tidy up
4fc4492
@moonraker595
Added better exception handling
cbd7ea4
@moonraker595
Added tests
1877e28
@moonraker595
Added more logging
ae9261c
VKTB
VKTB reviewed Nov 14, 2024
View reviewed changes
Copy link
Contributor

@VKTB VKTB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions but looks good otherwise. 🎉

.github/workflows/main.yml Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
api/auth.py Outdated Show resolved Hide resolved
requirements.txt Outdated Show resolved Hide resolved
moonraker595 and others added 6 commits November 14, 2024 14:14
@moonraker595 @VKTB
Update Dockerfile
7ea79cd 
Co-authored-by: Viktor Bozhinov <45173816+VKTB@users.noreply.github.com>
@moonraker595 @VKTB
Update .github/workflows/main.yml
b79da3b 
Co-authored-by: Viktor Bozhinov <45173816+VKTB@users.noreply.github.com>
@moonraker595
Added logger.exception
44c462d
@moonraker595
Added non-root user and commit SHA for python version
710673d
@moonraker595
Added some more comments
fea46be
@moonraker595
Pinning versions
30163a4
@moonraker595
Copy link
Contributor Author

Thanks for the review. These are all great comments. I have addressed them all. If it's okay with you, I'll go ahead and merge.

@VKTB
Copy link
Contributor

VKTB commented Nov 15, 2024

Thanks for the review. These are all great comments. I have addressed them all. If it's okay with you, I'll go ahead and merge.

Yes, feel free to do so.

@moonraker595 moonraker595 merged commit acce5e4 into main Nov 15, 2024
2 checks passed
@moonraker595 moonraker595 deleted the api_creation branch November 15, 2024 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VKTB VKTB VKTB approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@moonraker595 @VKTB