Add API endpoints for departments #1138
Open
+247
−9
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
Open
michplunkett
commented
Dec 19, 2024
OpenOversight/app/api/v1/api.py
Outdated
Comment on lines
18
to
19
| @v1.route("/departments/<int:department_id>/officers", methods=[HTTPMethod.GET]) | ||
| def download_dept_officers(department_id: int): |
There was a problem hiding this comment.
Using one of the formats here: #385 (comment)
Thoughts, @sea-kelp @abandoned-prototype @b-meson @AetherUnbound?
3 tasks
michplunkett
added a commit
that referenced
this pull request
Jan 2, 2025
## Description of Changes Addressed inconsistencies with the model `__repr__` functions. Mostly making this because this PR got a bit out of control: #1138 ## Tests and Linting - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.
michplunkett
added a commit
that referenced
this pull request
Jan 6, 2025
## Fixes issue Sets the groundwork for this issue: #385 ## Description of Changes Simplifying the import logic for the `auth` and `main` routes of the application. This also sets up the work for this PR: #1138 ## Tests and Linting - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.
Open
michplunkett
requested review from
b-meson,
AetherUnbound,
abandoned-prototype and
sea-kelp
michplunkett
commented
Jan 17, 2025
Comment on lines
+134
to
+145
| cache_params = (Department(id=department_id), KEY_DEPT_ALL_NOTES) | ||
| notes = get_database_cache_entry(*cache_params) | ||
|
|
||
| if notes is None: | ||
| notes = ( | ||
| db.session.query(Description) | ||
| .join(Description.officer) | ||
| .filter(Officer.department_id == department_id) | ||
| .options(contains_eager(Description.officer)) | ||
| .all() | ||
| ) | ||
| put_database_cache_entry(*cache_params, notes) |
There was a problem hiding this comment.
It might be worth moving these to static functions on each of the objects since they are used both here and in views.
|
Things that might be needed, are documentation for these endpoints. I'm not sure what a good protocol is for that rn, though I'm welcome to suggestions. |
michplunkett
commented
Jan 17, 2025
Comment on lines
+38
to
+41
| resp_assignments = client.get( | ||
| url_for("v1.get_dept_assignments", department_id=department_id), | ||
| follow_redirects=True, | ||
| ) |
There was a problem hiding this comment.
I could probably get rid of follow_redirects, but I think it might be worth keeping in case we modify the endpoint at some point.
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.
Fixes issue
#385
Description of Changes
Add the baseline features for a data-focused API.
Tests and Linting
developbranch.pytestpasses on my local development environment.pre-commitpasses on my local development environment.