18F/crime-data-api

View on GitHub
CHANGELOG.md

Summary

Maintainability
Test Coverage
# Change Log
All notable changes to this project will be documented in this file.
## [2018-1-17]
### Fizxed
- NIBRS National Endpoints now return values properly (https://github.com/18F/crime-data-api/pull/672))
 
 
## [2017-12-11]
### Added
- Adds new NIBRS Endpoints that accurately return NIBRS offense,victim,offender, and relationship counts (https://github.com/18F/crime-data-api/pull/672))
 
## [2017-11-27]
### Fixed
- Fixed issue with CDE not showing 2016 Agency Data (https://github.com/18F/crime-data-api/pull/653))
 
## [2017-11-14]
### Changed
- Changes Region Code Lookup to use Region Name (https://github.com/18F/crime-data-api/tree/CDE-191))
 
## [2017-11-07]
### Added
- Adds new Endpoints for Region Participation Data ([#636](https://github.com/18F/crime-data-api/pull/636))
 
## [2017-10-31]
### Added
- Adds new Endpoints for Region Data ([#636](https://github.com/18F/crime-data-api/pull/636))
 
 
## [2017-09-18]
### Added
- Include 2015 data ([#624](https://github.com/18F/crime-data-api/pull/624))
 
### Changed
- Do not include 2016 data in returned results ([#628](https://github.com/18F/crime-data-api/pull/628))
 
 
## [2017-07-20]
### Added
- UCR participation to S3 reports file ([#577](https://github.com/18F/crime-data-api/pull/577))
- A script for updating agency names from CSV ([#603](https://github.com/18F/crime-data-api/pull/603))
- Arrest data ([#608](https://github.com/18F/crime-data-api/pull/608))
- `nibrs_start_year` to agencies to represent the first year of reporting NIBRS ([#614](https://github.com/18F/crime-data-api/pull/614))
- Offense API endpoint allows `offense_name` as a variable ([#618](https://github.com/18F/crime-data-api/pull/618))
 
### Changed
- "LEOKA" changed to "assaults on law enforcement officers" in API documentation ([#619](https://github.com/18F/crime-data-api/pull/619))
 
### Fixed
- NIBRS participation years for some agencies ([#612](https://github.com/18F/crime-data-api/issues/612))
 
 
## [2017-06-30]
### Added
- Territory data ([#575](https://github.com/18F/crime-data-api/pull/575))
 
### Changed
- Partitioned NIBRS count views into ORI and State/national counts ([#573](https://github.com/18F/crime-data-api/pull/573))
- Documentation updated ([#579](https://github.com/18F/crime-data-api/pull/579))
- Augment `cde_agencies` with edited names, ICPSR geocoding ([#584](https://github.com/18F/crime-data-api/issues/584), [#588](https://github.com/18F/crime-data-api/pull/588))
- Deployment URLs ([#595](https://github.com/18F/crime-data-api/pull/595))
- Use the cf connect-to-service plugin for DB tunnels ([#602](https://github.com/18F/crime-data-api/pull/602))
 
### Fixed
- `victim_count_ori` query ([#589](https://github.com/18F/crime-data-api/pull/589))
 
### Removed
- `/counts` endpoint and `reta_month_offense_subcat_summary` table ([#583](https://github.com/18F/crime-data-api/pull/583))
- Remove some remaining authentication remnants ([#593](https://github.com/18F/crime-data-api/pull/593))
 
 
## [2017-06-22]
### Added
- Add participating population for NIBRS to `participation_rate` ([#558](https://github.com/18F/crime-data-api/pull/558))
- Add `/arson` endpoints ([#559](https://github.com/18F/crime-data-api/pull/559))
- Scripts to generate NIBRS downloads ([#563](https://github.com/18F/crime-data-api/pull/563))
- Add `past_10_years_reported` to `cde_agencies` ([#572](https://github.com/18F/crime-data-api/pull/572))
- Add territory data ([#575](https://github.com/18F/crime-data-api/pull/575))
 
### Changed
- Return `null` if the primary county for an agency is unspecified ([#534](https://github.com/18F/crime-data-api/pull/534))
- Aggravated assault should not include simple assault ([#570](https://github.com/18F/crime-data-api/pull/570))
- Reduce size of test database slice ([#571](https://github.com/18F/crime-data-api/pull/571))
- Upgrade Werkzeug to 0.12.22 ([#574](https://github.com/18F/crime-data-api/pull/574))
 
### Removed
- Support for open ended queries of the database using `TableFamily` ([#555](https://github.com/18F/crime-data-api/issues/555))
 
 
## [2017-06-09]
### Fixed
- Explicitly release connections on thrown exceptions and use correct imported database class in `models.py` ([#550](https://github.com/18F/crime-data-api/pull/550))
 
 
## [2017-06-08]
### Added
- Endpoints for ORI Return A data and aggregated totals based on NIBRS dimensions ([#507](https://github.com/18F/crime-data-api/pull/507))
- Agency endpoints support `fields` parameter ([#511](https://github.com/18F/crime-data-api/pull/511))
- Add CORS header to the endpoints and `swagger.json` ([#520](https://github.com/18F/crime-data-api/pull/520))
- Create an offense-grouped version of agency_sums table ([#524](https://github.com/18F/crime-data-api/pull/524))
- Endpoints for human trafficking data (`/ht/agencies` and `/ht/states`) ([#533](https://github.com/18F/crime-data-api/pull/533))
 
### Changed
- Rename `/agencies/count/states/offenses/:state/:ori` endpoint ([#492](https://github.com/18F/crime-data-api/issues/492))
- Performance improvements for endpoints that return large response ([#521](https://github.com/18F/crime-data-api/pull/521), [#522](https://github.com/18F/crime-data-api/pull/522))
- Suboffense endpoint accepts `explorer_offense` argument ([#523](https://github.com/18F/crime-data-api/pull/523))
- Agency offenses endpoint support classification (property, violent) and arson ([#529](https://github.com/18F/crime-data-api/issues/529))
- Use gunicorn for the production web server ([#542](https://github.com/18F/crime-data-api/pull/542))
 
### Fixed
- Include NIBRS offenses of "incest" and "sexual assault with an object" in response for "rape" ([#129](https://github.com/18F/crime-data-explorer/issues/129))
- Use `reta_month` to get `current_year` for `cde_agencies` ([#501](https://github.com/18F/crime-data-api/issues/501))
- Participation endpoint is now case-insensitive ([#526](https://github.com/18F/crime-data-api/issues/526))
 
### Removed
- The `aggregate_many` param removed from documentation
 
 
## [2017-05-12]
### Added
- Add core city flag to agencies. Create `revised_rape_start` column to indicate when an agency switched over to revised rape definition. Append " County" to the agency names for county agencies that don't already include it ([#457](https://github.com/18F/crime-data-api/pull/457))
- Endpoints for offense level counts by ORI, and county FIPS code. Agency level aggregate counts endpoint can return CSV ([#478](https://github.com/18F/crime-data-api/pull/478), [#487](https://github.com/18F/crime-data-api/pull/487))
 
### Changed
- Change the participation tables are built ([#475](https://github.com/18F/crime-data-api/pull/475))
- Point swagger documentation to api.usa.gov ([#479](https://github.com/18F/crime-data-api/pull/479))
- State abbreviation is case-insensitive ([#498](https://github.com/18F/crime-data-api/issues/498))
 
### Fixed
- Large request pagination ([#488](https://github.com/18F/crime-data-api/pull/488))
- Estimated endpoint returns data sorted by year ([#489](https://github.com/18F/crime-data-api/issues/489))
 
 
## [2017-04-26]
### Added
- Create new denormalized table for agency annual counts ([#455](https://github.com/18F/crime-data-api/pull/455))
- Load estimated data ([#469](https://github.com/18F/crime-data-api/pull/469))
 
### Changed
- Close off every database connection at the end of a transaction ([#470](https://github.com/18F/crime-data-api/pull/470))
 
 
## [2017-04-12]
### Added
- Include API introduction text in Swagger documentation ([#461](https://github.com/18F/crime-data-api/pull/461))
 
### Changed
- Restore `/agencies` and `/agencies/:ori` endpoints ([#452](https://github.com/18F/crime-data-api/pull/452))
 
### Removed
- Removed unused code in `CdeNibrsIncident` and `CdeRetaMonth` classes ([#441](https://github.com/18F/crime-data-api/pull/441/files))
- Remove `/geo/states/<state_abbr>/participation` and `/incidents/count` endpoints ([#463](https://github.com/18F/crime-data-api/pull/463))
 
 
## [2017-03-29]
### Added
- Alias the `/incidents/count` endpoint to `/counts` ([#281](https://github.com/18F/crime-data-api/issues/281))
- Allow api key via the X-API-KEY HTTP header ([#434](https://github.com/18F/crime-data-api/issues/434))
- Add new `/participation` endpoints for consistency ([#440](https://github.com/18F/crime-data-api/pull/440))
 
### Changed
- Do not generate `swagger.json` to give more control over API documentation ([#435](https://github.com/18F/crime-data-api/pull/435))
 
### Fixed
- Show `/codes` endpoint in Swagger ([#196](https://github.com/18F/crime-data-api/issues/196))
- Pagination parameters should not exceed total pages ([#336](https://github.com/18F/crime-data-api/issues/336))
- Remove duplicate variable parameters for count endpoints ([#382](https://github.com/18F/crime-data-api/issues/382))
- Use state postal abbreviation for `/offender/offense` endpoint ([#403](https://github.com/18F/crime-data-api/issues/403))
 
 
## [2017-03-15]
### Added
- Caching headers to API responses ([#395](https://github.com/18F/crime-data-api/issues/395))
- National participation endpoint ([#415](https://github.com/18F/crime-data-api/pull/415))
 
### Changed
- Reorder columns in agency participation CSV ([#414](https://github.com/18F/crime-data-api/pull/414))
 
### Fixed
- Arson data included in summary data ([#399](https://github.com/18F/crime-data-api/issues/399))
- Fix "R" and "U" offender relationship values ([#408](https://github.com/18F/crime-data-api/issues/408))
- Recompute state and county populations using ref_agency_population ([#412](https://github.com/18F/crime-data-api/issues/412))
- Rebuild participation table with the same renaming strategy as `reta_month_offense_subcat_summary` ([#417](https://github.com/18F/crime-data-api/issues/417))
- Participation table also computes covered population for NIBRS ([](https://github.com/18F/crime-data-api/issues/419))
- National endpoint returns aggregated data ([#420](https://github.com/18F/crime-data-api/issues/420))