[Issue 605] Create a basic opportunity search endpoint #615
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
acouch
approved these changes
Oct 27, 2023
daphnegold
approved these changes
Oct 27, 2023
| stmt = ( | ||
| select(Opportunity) | ||
| .order_by(sort_fn(getattr(Opportunity, search_params.sorting.order_by))) | ||
| .order_by() |
There was a problem hiding this comment.
We talked about removing this extra order_by() before shipping, just a reminder
There was a problem hiding this comment.
Added when I merged from main
3 tasks
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.
Summary
Fixes #605 (Part 2/2)
This is built ontop of #613 and assumes that will be merged first.
Time to review: 15 mins
Changes proposed
Created a basic opportunity search endpoint with pagination
Added a few simple filters to the endpoint
Added a basic script to seed the local DB with opportunities
Context for reviewers
This adds the basic structure and implementation of an endpoint for querying for opportunities and filtering the results. Only a few fields are currently able to be filtered, but adding more is pretty straightforward.
I'm not sure of the best way to structure the tests, I think as we add more features to the endpoint + more fields, we'll likely adjust the structure of the tests. Went with a fairly straightforward approach at the moment.
Additional information
Running
make db-seed-localwill populate your local DB with 25 opportunities each time it runs.Running
make run-logslets you run the API + see the logs. Going to http://localhost:8080/docs you can find the new opportunity endpoint which you can query and get results:The basic logging from the template works:
ks: