Add OAS Specifications for v2 API #397
Merged
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
- officers - agencies - partners - litigation - common schemas for error and pagination
DMalone87
added
enhancement
|
The current version of the API docs can be found on Readme.com. |
- Includes Pydantic models for the main OAS schemas - Also updated ID -> UID to comply with Neo4j reqs
- Associate officers with units, not agencies - Add website url to review boards - Differenciate command posts from standard officer employment - Rename officer associations (investigators, commanders, etc.) Update OAS README
DMalone87
commented
Sep 7, 2024
DMalone87
commented
Sep 7, 2024
DMalone87
commented
Sep 16, 2024
- Enthinicy enums added. Choices are based on the US DOI standards for observeer collected demographic data. https://www.doi.gov/pmb/eeo/directives/race-data - Added dates to Unit and Penalty. - UID added to penalties
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.
This PR adds specifications that represent the next edition of the NPDI API. This spec will help guide future development internally and potential integrations with partner organizations.
This also includes a script that converts the OAS schemas into Pydantic models that can be used to validate alterations to the database. This is required for the update to the database (#407) which will remove SQL Alchemy and the current schema generation logic. This will also support the work on the ETL pipeline in the Scraper repo.