Merge pull request #3054 from alphagov/intellectual-property-office-f…

…inder IPO trademark decisions finder
alphagov · Feb 20, 2025 · 8f6293b · 8f6293b
2 parents 9d9ea20 + 27ae463
commit 8f6293b
Show file tree

Hide file tree

Showing 16 changed files with 368 additions and 4 deletions.
diff --git a/content_schemas/allowed_document_types.yml b/content_schemas/allowed_document_types.yml
@@ -167,6 +167,7 @@
 - terms_of_reference
 - topical_event
 - topical_event_about_page
+- trademark_decision
 - traffic_commissioner_regulatory_decision
 - traffic_commissioner_role
 - transaction

diff --git a/content_schemas/dist/formats/finder/frontend/schema.json b/content_schemas/dist/formats/finder/frontend/schema.json
@@ -399,7 +399,7 @@
             "description": "Possible values to show for non-dynamic select facets. All values are shown regardless of the search.",
             "type": "array",
             "items": {
-              "$ref": "#/definitions/label_value_pair"
+              "$ref": "#/definitions/label_value_pair_with_sub_facets"
             }
           },
           "closed_value": {
@@ -454,6 +454,10 @@
             "description": "Label for the facet.",
             "type": "string"
           },
+          "nested_facet": {
+            "description": "Indicates whether this facet has nested sub facets within allowed values or not.",
+            "type": "boolean"
+          },
           "open_on_load": {
             "description": "When set to true, the option select facet will always be open on page load",
             "type": "boolean"
@@ -486,6 +490,14 @@
             "description": "Controls whether Option Select Facet displays a filter field",
             "type": "boolean"
           },
+          "sub_facet_key": {
+            "description": "The key field name used for the subcategory of this facet.",
+            "type": "string"
+          },
+          "sub_facet_name": {
+            "description": "The human readable label of the field name used for the subcategory of this facet.",
+            "type": "string"
+          },
           "type": {
             "description": "Defines the UI component and how the facet is queried from the search API",
             "type": "string",
@@ -815,6 +827,36 @@
         }
       }
     },
+    "label_value_pair_with_sub_facets": {
+      "description": "One of many possible values a user can select from",
+      "type": "object",
+      "required": [
+        "label",
+        "value"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "default": {
+          "description": "The default option for a radio facet",
+          "type": "boolean"
+        },
+        "label": {
+          "description": "A human readable label",
+          "type": "string"
+        },
+        "sub_facets": {
+          "description": "Possible values to show for non-dynamic select nested facets. All values are shown regardless of the search.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/label_value_pair"
+          }
+        },
+        "value": {
+          "description": "A value to use for form controls",
+          "type": "string"
+        }
+      }
+    },
     "locale": {
       "type": "string",
       "enum": [

diff --git a/content_schemas/dist/formats/finder/notification/schema.json b/content_schemas/dist/formats/finder/notification/schema.json
@@ -499,7 +499,7 @@
             "description": "Possible values to show for non-dynamic select facets. All values are shown regardless of the search.",
             "type": "array",
             "items": {
-              "$ref": "#/definitions/label_value_pair"
+              "$ref": "#/definitions/label_value_pair_with_sub_facets"
             }
           },
           "closed_value": {
@@ -554,6 +554,10 @@
             "description": "Label for the facet.",
             "type": "string"
           },
+          "nested_facet": {
+            "description": "Indicates whether this facet has nested sub facets within allowed values or not.",
+            "type": "boolean"
+          },
           "open_on_load": {
             "description": "When set to true, the option select facet will always be open on page load",
             "type": "boolean"
@@ -586,6 +590,14 @@
             "description": "Controls whether Option Select Facet displays a filter field",
             "type": "boolean"
           },
+          "sub_facet_key": {
+            "description": "The key field name used for the subcategory of this facet.",
+            "type": "string"
+          },
+          "sub_facet_name": {
+            "description": "The human readable label of the field name used for the subcategory of this facet.",
+            "type": "string"
+          },
           "type": {
             "description": "Defines the UI component and how the facet is queried from the search API",
             "type": "string",
@@ -928,6 +940,36 @@
         }
       }
     },
+    "label_value_pair_with_sub_facets": {
+      "description": "One of many possible values a user can select from",
+      "type": "object",
+      "required": [
+        "label",
+        "value"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "default": {
+          "description": "The default option for a radio facet",
+          "type": "boolean"
+        },
+        "label": {
+          "description": "A human readable label",
+          "type": "string"
+        },
+        "sub_facets": {
+          "description": "Possible values to show for non-dynamic select nested facets. All values are shown regardless of the search.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/label_value_pair"
+          }
+        },
+        "value": {
+          "description": "A value to use for form controls",
+          "type": "string"
+        }
+      }
+    },
     "locale": {
       "type": "string",
       "enum": [

diff --git a/content_schemas/dist/formats/finder/publisher_v2/schema.json b/content_schemas/dist/formats/finder/publisher_v2/schema.json
@@ -291,7 +291,7 @@
             "description": "Possible values to show for non-dynamic select facets. All values are shown regardless of the search.",
             "type": "array",
             "items": {
-              "$ref": "#/definitions/label_value_pair"
+              "$ref": "#/definitions/label_value_pair_with_sub_facets"
             }
           },
           "closed_value": {
@@ -346,6 +346,10 @@
             "description": "Label for the facet.",
             "type": "string"
           },
+          "nested_facet": {
+            "description": "Indicates whether this facet has nested sub facets within allowed values or not.",
+            "type": "boolean"
+          },
           "open_on_load": {
             "description": "When set to true, the option select facet will always be open on page load",
             "type": "boolean"
@@ -378,6 +382,14 @@
             "description": "Controls whether Option Select Facet displays a filter field",
             "type": "boolean"
           },
+          "sub_facet_key": {
+            "description": "The key field name used for the subcategory of this facet.",
+            "type": "string"
+          },
+          "sub_facet_name": {
+            "description": "The human readable label of the field name used for the subcategory of this facet.",
+            "type": "string"
+          },
           "type": {
             "description": "Defines the UI component and how the facet is queried from the search API",
             "type": "string",
@@ -581,6 +593,36 @@
         }
       }
     },
+    "label_value_pair_with_sub_facets": {
+      "description": "One of many possible values a user can select from",
+      "type": "object",
+      "required": [
+        "label",
+        "value"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "default": {
+          "description": "The default option for a radio facet",
+          "type": "boolean"
+        },
+        "label": {
+          "description": "A human readable label",
+          "type": "string"
+        },
+        "sub_facets": {
+          "description": "Possible values to show for non-dynamic select nested facets. All values are shown regardless of the search.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/label_value_pair"
+          }
+        },
+        "value": {
+          "description": "A value to use for form controls",
+          "type": "string"
+        }
+      }
+    },
     "locale": {
       "type": "string",
       "enum": [

diff --git a/content_schemas/dist/formats/generic/frontend/schema.json b/content_schemas/dist/formats/generic/frontend/schema.json
@@ -203,6 +203,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",

diff --git a/content_schemas/dist/formats/generic/notification/schema.json b/content_schemas/dist/formats/generic/notification/schema.json
@@ -227,6 +227,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",

diff --git a/content_schemas/dist/formats/generic/publisher_v2/schema.json b/content_schemas/dist/formats/generic/publisher_v2/schema.json
@@ -216,6 +216,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",

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
@@ -203,6 +203,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",

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
@@ -227,6 +227,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",

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
@@ -216,6 +216,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",

diff --git a/content_schemas/dist/formats/specialist_document/frontend/schema.json b/content_schemas/dist/formats/specialist_document/frontend/schema.json
@@ -203,6 +203,7 @@
         "terms_of_reference",
         "topical_event",
         "topical_event_about_page",
+        "trademark_decision",
         "traffic_commissioner_regulatory_decision",
         "traffic_commissioner_role",
         "transaction",
@@ -697,6 +698,9 @@
         {
           "$ref": "#/definitions/tax_tribunal_decision_metadata"
         },
+        {
+          "$ref": "#/definitions/trademark_decision_metadata"
+        },
         {
           "$ref": "#/definitions/traffic_commissioner_regulatory_decision_metadata"
         },
@@ -2050,6 +2054,49 @@
     "title": {
       "type": "string"
     },
+    "trademark_decision_metadata": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "bulk_published": {
+          "type": "boolean"
+        },
+        "trademark_decision_appointed_person_hearing_officer": {
+          "type": "string"
+        },
+        "trademark_decision_british_library_number": {
+          "type": "string"
+        },
+        "trademark_decision_class": {
+          "type": "string"
+        },
+        "trademark_decision_date": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
+        },
+        "trademark_decision_grounds_section": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "trademark_decision_grounds_sub_section": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "trademark_decision_mark": {
+          "type": "string"
+        },
+        "trademark_decision_person_or_company_involved": {
+          "type": "string"
+        },
+        "trademark_decision_type_of_hearing": {
+          "type": "string"
+        }
+      }
+    },
     "traffic_commissioner_regulatory_decision_metadata": {
       "type": "object",
       "additionalProperties": false,