feat: Add linz:slug field TDE-1283

linz · Oct 17, 2024 · 4b8d82a · 4b8d82a
1 parent 6054f13
commit 4b8d82a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/extensions/linz/examples/collection.json b/extensions/linz/examples/collection.json
@@ -70,6 +70,7 @@
   "quality:horizontal_accuracy_type": "nominal",
   "linz:history": "This is an example dataset lineage description.",
   "linz:update_frequency": "P1Y",
+  "linz:slug": "new-zealand_2015_1m",
   "providers": [
     {
       "name": "Example",

diff --git a/extensions/linz/schema.json b/extensions/linz/schema.json
@@ -114,6 +114,12 @@
                   "wellington",
                   "west-coast"
                 ]
+              },
+              "linz:slug": {
+                "type": "string",
+                "minLength": 1,
+                "description": "The '<name>-<date>-<GSD>' part of the Open Data Registry path.",
+                "examples": ["banks-peninsula_2019-2020_0.075m", "new-zealand_2015_1m"]
               }
             }
           },
@@ -1088,6 +1094,7 @@
           "type": "string",
           "enum": ["unclassified", "in-confidence", "sensitive", "restricted", "confidential", "secret", "top-secret"]
         },
+        "linz:slug": {},
         "linz:update_frequency": {
           "type": "string",
           "format": "duration"

diff --git a/extensions/linz/tests/linz_collection.test.mjs b/extensions/linz/tests/linz_collection.test.mjs
@@ -579,4 +579,21 @@ o.spec('LINZ collection', () => {
     // then
     o(valid).equals(true);
   });
+
+  o("Collection with invalid 'linz:slug' value should fail validation", async () => {
+    // given
+    const example = JSON.parse(await fs.readFile(examplePath));
+    example['linz:slug'] = '';
+
+    // when
+    let valid = validate(example);
+
+    // then
+    o(valid).equals(false);
+    o(
+      validate.errors.some(
+        (error) => error.instancePath === '/linz:slug' && error.message === 'must NOT have fewer than 1 characters',
+      ),
+    ).equals(true)(JSON.stringify(validate.errors));
+  });
 });