Merge pull request #2750 from alphagov/schema_for_popular_links

Schema for popular links
alphagov · Jun 4, 2024 · c510f46 · c510f46
2 parents 84b2852 + ea265eb
commit c510f46
Show file tree

Hide file tree

Showing 18 changed files with 2,010 additions and 3 deletions.
diff --git a/content_schemas/allowed_document_types.yml b/content_schemas/allowed_document_types.yml
@@ -79,6 +79,7 @@
 - licence
 - license_finder
 - licence_transaction
+- link_collection
 - local_transaction
 - maib_report
 - mainstream_browse_page

diff --git a/content_schemas/dist/formats/generic/frontend/schema.json b/content_schemas/dist/formats/generic/frontend/schema.json
@@ -115,6 +115,7 @@
         "licence",
         "license_finder",
         "licence_transaction",
+        "link_collection",
         "local_transaction",
         "maib_report",
         "mainstream_browse_page",

diff --git a/content_schemas/dist/formats/generic/notification/schema.json b/content_schemas/dist/formats/generic/notification/schema.json
@@ -139,6 +139,7 @@
         "licence",
         "license_finder",
         "licence_transaction",
+        "link_collection",
         "local_transaction",
         "maib_report",
         "mainstream_browse_page",

diff --git a/content_schemas/dist/formats/generic/publisher_v2/schema.json b/content_schemas/dist/formats/generic/publisher_v2/schema.json
@@ -125,6 +125,7 @@
         "licence",
         "license_finder",
         "licence_transaction",
+        "link_collection",
         "local_transaction",
         "maib_report",
         "mainstream_browse_page",

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
@@ -115,6 +115,7 @@
         "licence",
         "license_finder",
         "licence_transaction",
+        "link_collection",
         "local_transaction",
         "maib_report",
         "mainstream_browse_page",

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
@@ -139,6 +139,7 @@
         "licence",
         "license_finder",
         "licence_transaction",
+        "link_collection",
         "local_transaction",
         "maib_report",
         "mainstream_browse_page",

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
@@ -125,6 +125,7 @@
         "licence",
         "license_finder",
         "licence_transaction",
+        "link_collection",
         "local_transaction",
         "maib_report",
         "mainstream_browse_page",

diff --git a/content_schemas/dist/formats/homepage/frontend/schema.json b/content_schemas/dist/formats/homepage/frontend/schema.json
@@ -88,6 +88,10 @@
           "description": "A largely deprecated tag currently only used to power email alerts.",
           "$ref": "#/definitions/frontend_links_with_base_path"
         },
+        "popular_links": {
+          "description": "Collection of links to be used to display popular links on homepage",
+          "$ref": "#/definitions/frontend_links_with_base_path"
+        },
         "related_to_step_navs": {
           "description": "Link type automatically added by Publishing API",
           "$ref": "#/definitions/frontend_links_with_base_path"

diff --git a/content_schemas/dist/formats/homepage/notification/schema.json b/content_schemas/dist/formats/homepage/notification/schema.json
@@ -106,6 +106,10 @@
           "description": "A largely deprecated tag currently only used to power email alerts.",
           "$ref": "#/definitions/frontend_links_with_base_path"
         },
+        "popular_links": {
+          "description": "Collection of links to be used to display popular links on homepage",
+          "$ref": "#/definitions/frontend_links_with_base_path"
+        },
         "related_to_step_navs": {
           "description": "Link type automatically added by Publishing API",
           "$ref": "#/definitions/frontend_links_with_base_path"
@@ -137,6 +141,10 @@
         "policy_areas": {
           "description": "A largely deprecated tag currently only used to power email alerts.",
           "$ref": "#/definitions/guid_list"
+        },
+        "popular_links": {
+          "description": "Collection of links to be used to display popular links on homepage",
+          "$ref": "#/definitions/guid_list"
         }
       }
     },

diff --git a/content_schemas/dist/formats/homepage/publisher_v2/links.json b/content_schemas/dist/formats/homepage/publisher_v2/links.json
@@ -9,11 +9,28 @@
     "links": {
       "type": "object",
       "additionalProperties": false,
-      "properties": {}
+      "properties": {
+        "popular_links": {
+          "description": "Collection of links to be used to display popular links on homepage",
+          "$ref": "#/definitions/guid_list"
+        }
+      }
     },
     "previous_version": {
       "type": "string"
     }
   },
-  "definitions": {}
+  "definitions": {
+    "guid": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
+    },
+    "guid_list": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/guid"
+      },
+      "uniqueItems": true
+    }
+  }
 }