Skip to content

Commit

Permalink
Add taxonomy_topic_email_override to document collection schema links
Browse files Browse the repository at this point in the history
    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
  • Loading branch information
BeckaL committed Jul 14, 2023
1 parent 41398e8 commit ffa093f
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 4 additions & 0 deletions content_schemas/formats/document_collection.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
},
}

0 comments on commit ffa093f

Please sign in to comment.