Skip to content

Commit

Permalink
OAS Updates
Browse files Browse the repository at this point in the history
- Add suffix to the officer record
- Add record IDs to complaints and allegations
- Add type and subtype to allegations
  • Loading branch information
DMalone87 committed Sep 26, 2024
1 parent 008334f commit 3ce4a51
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
7 changes: 2 additions & 5 deletions oas/2.0/agencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,6 @@ components:
BaseAgency:
type: "object"
properties:
uid:
type: "string"
description: "Unique identifier for the agency"
name:
type: "string"
description: "Name of the agency"
Expand Down Expand Up @@ -323,8 +320,8 @@ components:
- type: "object"
properties:
uid:
type: "string"
description: "Unique identifier for the agency"
type: string
description: Unique identifier for the agency
officers_url:
type: "string"
description: "URL to get a list of officers for this agency"
Expand Down
12 changes: 12 additions & 0 deletions oas/2.0/complaints.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ components:
type: "object"
description: "Base complaint object"
properties:
record_id:
type: string
description: The ID that was given to this complaint by the orginal source of the data.
source_details:
$ref: '#/components/schemas/SourceDetails'
category:
Expand Down Expand Up @@ -315,6 +318,9 @@ components:
BaseAllegation:
type: "object"
properties:
record_id:
type: string
description: The ID that was given to this allegation by the orginal source of the data.
complaintant:
allOf:
- $ref: "#/components/schemas/Civilian"
Expand All @@ -323,6 +329,12 @@ components:
allegation:
type: "string"
description: "The allegation made by the complaintant."
type:
type: string
description: The type of allegation.
sub_type:
type: string
description: The sub type of the allegation.
recomended_finding:
type: "string"
description: "The finding recomended by the review board."
Expand Down
7 changes: 5 additions & 2 deletions oas/2.0/officers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,11 @@ components:
earliest_employment:
type: "string"
format: "date"
description: "The earliest date of employment"
description: "The earliest known date of employment"
latest_employment:
type: "string"
format: "date"
description: "The latest date of employment"
description: "The latest known date of employment"
badge_number:
type: "string"
description: "The badge number of the officer"
Expand Down Expand Up @@ -270,6 +270,9 @@ components:
last_name:
type: "string"
description: "Last name of the officer"
suffix:
type: "string"
description: "Suffix of the officer's name"
ethnicity:
type: "string"
description: "The ethnicity of the officer"
Expand Down

0 comments on commit 3ce4a51

Please sign in to comment.