From ffa093f2d987944b90f0af64a097bb78df085459 Mon Sep 17 00:00:00 2001 From: BeckaL Date: Fri, 14 Jul 2023 09:42:00 +0100 Subject: [PATCH] Add taxonomy_topic_email_override to document collection schema links This is an optional field that, if present, will contain the base path of the taxonomy that the document collection's email signup button should instead be used as the url to signup a user for email subscriptions. This is part of work to retire specialist topics, and is being implemented specifically to support behaviour requested by HMRC for a small number of document collections that have been created to replace specialist topics. This field will not be present for the vast majority of document collections --- .../formats/document_collection/frontend/schema.json | 5 +++++ .../document_collection/notification/schema.json | 10 ++++++++++ .../document_collection/publisher_v2/links.json | 5 +++++ content_schemas/formats/document_collection.jsonnet | 4 ++++ 4 files changed, 24 insertions(+) diff --git a/content_schemas/dist/formats/document_collection/frontend/schema.json b/content_schemas/dist/formats/document_collection/frontend/schema.json index 90cae6dad..976c4c5db 100644 --- a/content_schemas/dist/formats/document_collection/frontend/schema.json +++ b/content_schemas/dist/formats/document_collection/frontend/schema.json @@ -159,6 +159,11 @@ "description": "New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.", "$ref": "#/definitions/frontend_links_with_base_path" }, + "taxonomy_topic_email_override": { + "description": "The taxonomy topic that email subscriptions for this document collection should go to - only for document collections converted from specialist topics", + "$ref": "#/definitions/frontend_links_with_base_path", + "maxItems": 1 + }, "taxons": { "description": "Prototype-stage taxonomy label for this content item", "$ref": "#/definitions/frontend_links_with_base_path" diff --git a/content_schemas/dist/formats/document_collection/notification/schema.json b/content_schemas/dist/formats/document_collection/notification/schema.json index a2db3854d..cb6ccb2a6 100644 --- a/content_schemas/dist/formats/document_collection/notification/schema.json +++ b/content_schemas/dist/formats/document_collection/notification/schema.json @@ -177,6 +177,11 @@ "description": "New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.", "$ref": "#/definitions/frontend_links_with_base_path" }, + "taxonomy_topic_email_override": { + "description": "The taxonomy topic that email subscriptions for this document collection should go to - only for document collections converted from specialist topics", + "$ref": "#/definitions/frontend_links_with_base_path", + "maxItems": 1 + }, "taxons": { "description": "Prototype-stage taxonomy label for this content item", "$ref": "#/definitions/frontend_links_with_base_path" @@ -271,6 +276,11 @@ "description": "New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.", "$ref": "#/definitions/guid_list" }, + "taxonomy_topic_email_override": { + "description": "The taxonomy topic that email subscriptions for this document collection should go to - only for document collections converted from specialist topics", + "$ref": "#/definitions/guid_list", + "maxItems": 1 + }, "taxons": { "description": "Prototype-stage taxonomy label for this content item", "$ref": "#/definitions/guid_list" diff --git a/content_schemas/dist/formats/document_collection/publisher_v2/links.json b/content_schemas/dist/formats/document_collection/publisher_v2/links.json index a62cb4c10..0961d03ef 100644 --- a/content_schemas/dist/formats/document_collection/publisher_v2/links.json +++ b/content_schemas/dist/formats/document_collection/publisher_v2/links.json @@ -77,6 +77,11 @@ "description": "New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.", "$ref": "#/definitions/guid_list" }, + "taxonomy_topic_email_override": { + "description": "The taxonomy topic that email subscriptions for this document collection should go to - only for document collections converted from specialist topics", + "$ref": "#/definitions/guid_list", + "maxItems": 1 + }, "taxons": { "description": "Prototype-stage taxonomy label for this content item", "$ref": "#/definitions/guid_list" diff --git a/content_schemas/formats/document_collection.jsonnet b/content_schemas/formats/document_collection.jsonnet index d950edf10..54cb062b8 100644 --- a/content_schemas/formats/document_collection.jsonnet +++ b/content_schemas/formats/document_collection.jsonnet @@ -80,5 +80,9 @@ related_mainstream_content: "", documents: "", topical_events: "The topical events that are part of this document collection.", + taxonomy_topic_email_override: { + description: "The taxonomy topic that email subscriptions for this document collection should go to - only for document collections converted from specialist topics", + maxItems: 1 + }, }, }