Merge pull request #2589 from alphagov/add-algorithmic-transparency-reports-document-type

ryanb-gds · web-flow · commit 7d72fe3a146e · 2024-01-19T11:54:42.000Z
Add algorithmic transparency record specialist document type
diff --git a/content_schemas/allowed_document_types.yml b/content_schemas/allowed_document_types.yml
@@ -4,6 +4,7 @@
 - accessible_documents_policy
 - access_and_opening
 - ai_assurance_portfolio_technique
+- algorithmic_transparency_record
 - ambassador_role
 - animal_disease_case
 - answer
diff --git a/content_schemas/dist/formats/generic/frontend/schema.json b/content_schemas/dist/formats/generic/frontend/schema.json
@@ -40,6 +40,7 @@
         "accessible_documents_policy",
         "access_and_opening",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "ambassador_role",
         "animal_disease_case",
         "answer",
diff --git a/content_schemas/dist/formats/generic/notification/schema.json b/content_schemas/dist/formats/generic/notification/schema.json
@@ -64,6 +64,7 @@
         "accessible_documents_policy",
         "access_and_opening",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "ambassador_role",
         "animal_disease_case",
         "answer",
diff --git a/content_schemas/dist/formats/generic/publisher_v2/schema.json b/content_schemas/dist/formats/generic/publisher_v2/schema.json
@@ -50,6 +50,7 @@
         "accessible_documents_policy",
         "access_and_opening",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "ambassador_role",
         "animal_disease_case",
         "answer",
diff --git a/content_schemas/dist/formats/generic_with_external_related_links/frontend/schema.json b/content_schemas/dist/formats/generic_with_external_related_links/frontend/schema.json
@@ -40,6 +40,7 @@
         "accessible_documents_policy",
         "access_and_opening",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "ambassador_role",
         "animal_disease_case",
         "answer",
diff --git a/content_schemas/dist/formats/generic_with_external_related_links/notification/schema.json b/content_schemas/dist/formats/generic_with_external_related_links/notification/schema.json
@@ -64,6 +64,7 @@
         "accessible_documents_policy",
         "access_and_opening",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "ambassador_role",
         "animal_disease_case",
         "answer",
diff --git a/content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json b/content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json
@@ -50,6 +50,7 @@
         "accessible_documents_policy",
         "access_and_opening",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "ambassador_role",
         "animal_disease_case",
         "answer",
diff --git a/content_schemas/dist/formats/specialist_document/frontend/schema.json b/content_schemas/dist/formats/specialist_document/frontend/schema.json
@@ -36,6 +36,7 @@
       "enum": [
         "aaib_report",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "animal_disease_case",
         "asylum_support_decision",
         "business_finance_support_scheme",
@@ -436,6 +437,122 @@
         }
       }
     },
+    "algorithmic_transparency_record_metadata": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "algorithmic_transparency_record_atrs_version": {
+          "type": "string"
+        },
+        "algorithmic_transparency_record_capability": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "computer-vision",
+              "computer-audition",
+              "computer-linguistics",
+              "robotics",
+              "forecasting",
+              "discovery",
+              "planning",
+              "creation",
+              "analysis",
+              "management",
+              "other"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_date_published": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
+        },
+        "algorithmic_transparency_record_function": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "general-public-services",
+              "defence",
+              "public-order-and-safety",
+              "economic-affairs",
+              "environmental-protection",
+              "housing-and-community-amenities",
+              "health",
+              "recreation-culture-and-religion",
+              "education",
+              "social-protection",
+              "regulation"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_organisation": {
+          "type": "string",
+          "enum": [
+            "cabinet-office",
+            "ministry-of-justice",
+            "information-commissioners-office",
+            "department-for-health-and-social-care",
+            "food-standards-agency",
+            "hampshire-and-thames-valley-police",
+            "west-midlands-police",
+            "department-for-science-innovation-and-technology",
+            "department-for-education"
+          ]
+        },
+        "algorithmic_transparency_record_organisation_type": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "ministerial-department",
+              "non-ministerial-department",
+              "agency-or-public-body",
+              "local-authority",
+              "devolved-administration",
+              "high-profile-group",
+              "public-corporation"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_other_tags": {
+          "type": "string"
+        },
+        "algorithmic_transparency_record_phase": {
+          "type": "string",
+          "enum": [
+            "pre-deployment",
+            "beta-pilot",
+            "production",
+            "retired"
+          ]
+        },
+        "algorithmic_transparency_record_region": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "northern-ireland",
+              "scotland",
+              "wales",
+              "england",
+              "london",
+              "north-east",
+              "north-west",
+              "yorkshire-and-the-humber",
+              "east-midlands",
+              "west-midlands",
+              "south-east",
+              "east-of-england",
+              "south-west"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_task": {
+          "type": "string"
+        }
+      }
+    },
     "analytics_identifier": {
       "description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
       "anyOf": [
@@ -521,6 +638,9 @@
         {
           "$ref": "#/definitions/ai_assurance_portfolio_technique_metadata"
         },
+        {
+          "$ref": "#/definitions/algorithmic_transparency_record_metadata"
+        },
         {
           "$ref": "#/definitions/animal_disease_case_metadata"
         },
diff --git a/content_schemas/dist/formats/specialist_document/notification/schema.json b/content_schemas/dist/formats/specialist_document/notification/schema.json
@@ -60,6 +60,7 @@
       "enum": [
         "aaib_report",
         "ai_assurance_portfolio_technique",
+        "algorithmic_transparency_record",
         "animal_disease_case",
         "asylum_support_decision",
         "business_finance_support_scheme",
@@ -528,6 +529,122 @@
         }
       }
     },
+    "algorithmic_transparency_record_metadata": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "algorithmic_transparency_record_atrs_version": {
+          "type": "string"
+        },
+        "algorithmic_transparency_record_capability": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "computer-vision",
+              "computer-audition",
+              "computer-linguistics",
+              "robotics",
+              "forecasting",
+              "discovery",
+              "planning",
+              "creation",
+              "analysis",
+              "management",
+              "other"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_date_published": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
+        },
+        "algorithmic_transparency_record_function": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "general-public-services",
+              "defence",
+              "public-order-and-safety",
+              "economic-affairs",
+              "environmental-protection",
+              "housing-and-community-amenities",
+              "health",
+              "recreation-culture-and-religion",
+              "education",
+              "social-protection",
+              "regulation"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_organisation": {
+          "type": "string",
+          "enum": [
+            "cabinet-office",
+            "ministry-of-justice",
+            "information-commissioners-office",
+            "department-for-health-and-social-care",
+            "food-standards-agency",
+            "hampshire-and-thames-valley-police",
+            "west-midlands-police",
+            "department-for-science-innovation-and-technology",
+            "department-for-education"
+          ]
+        },
+        "algorithmic_transparency_record_organisation_type": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "ministerial-department",
+              "non-ministerial-department",
+              "agency-or-public-body",
+              "local-authority",
+              "devolved-administration",
+              "high-profile-group",
+              "public-corporation"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_other_tags": {
+          "type": "string"
+        },
+        "algorithmic_transparency_record_phase": {
+          "type": "string",
+          "enum": [
+            "pre-deployment",
+            "beta-pilot",
+            "production",
+            "retired"
+          ]
+        },
+        "algorithmic_transparency_record_region": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "northern-ireland",
+              "scotland",
+              "wales",
+              "england",
+              "london",
+              "north-east",
+              "north-west",
+              "yorkshire-and-the-humber",
+              "east-midlands",
+              "west-midlands",
+              "south-east",
+              "east-of-england",
+              "south-west"
+            ]
+          }
+        },
+        "algorithmic_transparency_record_task": {
+          "type": "string"
+        }
+      }
+    },
     "analytics_identifier": {
       "description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
       "anyOf": [
@@ -613,6 +730,9 @@
         {
           "$ref": "#/definitions/ai_assurance_portfolio_technique_metadata"
         },
+        {
+          "$ref": "#/definitions/algorithmic_transparency_record_metadata"
+        },
         {
           "$ref": "#/definitions/animal_disease_case_metadata"
         },
diff --git a/content_schemas/dist/formats/specialist_document/publisher_v2/schema.json b/content_schemas/dist/formats/specialist_document/publisher_v2/schema.json
diff --git a/content_schemas/examples/specialist_document/frontend/algorithmic-transparency-record.json b/content_schemas/examples/specialist_document/frontend/algorithmic-transparency-record.json
diff --git a/content_schemas/formats/shared/definitions/_specialist_document.jsonnet b/content_schemas/formats/shared/definitions/_specialist_document.jsonnet
diff --git a/content_schemas/formats/specialist_document.jsonnet b/content_schemas/formats/specialist_document.jsonnet
