Updates to schema properties

- 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
codeforboston · Sep 16, 2024 · 50060ad · 50060ad
1 parent 3d9bbea
commit 50060ad
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 11 deletions.
diff --git a/oas/2.0/agencies.yaml b/oas/2.0/agencies.yaml
@@ -374,6 +374,10 @@ components:
         zip:
           type: "string"
           description: "Zip code of the unit"
+        date_established:
+          type: string
+          description: The date that this unit was established by its parent agency.
+          format: date
     Unit:
       allOf: 
         - $ref: "#/components/schemas/BaseUnit"

diff --git a/oas/2.0/complaints.yaml b/oas/2.0/complaints.yaml
@@ -359,6 +359,9 @@ components:
     Penalty:
       type: "object"
       properties:
+        uid:
+          type: string
+          description: UUID for the penalty.
         officer:
           allOf: 
             - $ref: officers.yaml#/components/schemas/Officer
@@ -367,6 +370,9 @@ components:
         description:
           type: "string"
           description: "A description of the penalty."
+        date_assesed:
+          type: string
+          format: date
     CreatePenalty:
       type: "object"
       properties:
@@ -414,21 +420,23 @@ components:
         age:
           type: "string"
           description: "Age range of the individual."
-        race:
+        ethnicity:
           type: "string"
-          description: "The race of the individual."
+          description: "The ethnicity of the individual."
           enum:
-            - "White"
-            - "Black"
-            - "Hispanic"
-            - "Asian"
-            - "Native American"
-            - "Other"
+            - American Indian or Alaska Native
+            - Asian
+            - Black or African American
+            - Hispanic or Latino
+            - Native Hawaiian or Other Pacific Islander
+            - White
         gender:
           type: "string"
+          description: The gender of the individual.
           enum:
             - Male
             - Female
+            - Other
     ReviewBoard:
       type: "object"
       properties:

diff --git a/oas/2.0/officers.yaml b/oas/2.0/officers.yaml
@@ -270,15 +270,23 @@ components:
         last_name:
           type: "string"
           description: "Last name of the officer"
-        race:
-          type: "string"
-          description: "The race of the officer"
         ethnicity:
           type: "string"
           description: "The ethnicity of the officer"
+          enum:
+            - American Indian or Alaska Native
+            - Asian
+            - Black or African American
+            - Hispanic or Latino
+            - Native Hawaiian or Other Pacific Islander
+            - White
         gender:
           type: "string"
           description: "The gender of the officer"
+          enum:
+            - Male
+            - Female
+            - Other
         date_of_birth:
           type: "string"
           format: "date"