Merge pull request #27 from impresso/data-workflow-versioning

Data Versioning Manifest
impresso · Feb 16, 2024 · 73d7b19 · 73d7b19
2 parents 2565152 + a97f3f5
commit 73d7b19
Show file tree

Hide file tree

Showing 91 changed files with 45,825 additions and 829 deletions.
diff --git a/Makefile b/Makefile
@@ -15,7 +15,7 @@ tests:
 	jsonschema -V Draft202012Validator -i examples/entities/example0.json  json/entities/entities.schema.json && $(print-test-ok)|| $(print-test-failed)
 	jsonschema -V Draft202012Validator -i examples/entities/example1.json  json/entities/entities.schema.json && $(print-test-ok)|| $(print-test-failed)
 	jsonschema -V Draft202012Validator -i examples/entities/example2.json  json/entities/entities.schema.json && $(print-test-ok)|| $(print-test-failed)
-
+	jsonschema -V Draft202012Validator -i examples/versioning_manifest/canonical_v0-0-1.json  json/versioning/manifest.schema.json && $(print-test-ok)|| $(print-test-failed)
 
 
 clean-documentation:
@@ -29,7 +29,7 @@ documentation:
 	jsonschema2md -d json/language_identification/ --header false -n -v 06 -o docs -x -  -s propTable
 	jsonschema2md -d json/entities/ --header false -n -v 2020-12 -o docs -x -  -s propTable
 	#jsonschema2md -d json/linguistic_annotation/ -n -v 06 -o docs
-
+	jsonschema2md -d json/versioning/ --header false -n -v 2024-02 -o docs -x -  -s propTable
 
 ##########################################################################################
 # Simple macros for tests

diff --git a/docs/contentitem-properties-d.md b/docs/contentitem-properties-d.md
@@ -4,7 +4,7 @@
 
 ## d Constraints
 
-**pattern**: the string must match the following regular expression: 
+**pattern**: the string must match the following regular expression:&#x20;
 
 ```regexp
 ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

diff --git a/docs/contentitem-properties-lg.md b/docs/contentitem-properties-lg.md
@@ -4,7 +4,7 @@
 
 ## lg Constraints
 
-**pattern**: the string must match the following regular expression: 
+**pattern**: the string must match the following regular expression:&#x20;
 
 ```regexp
 ^[a-z]{2}$

diff --git a/docs/contentitem-properties-ppreb-items-properties-t-items.md b/docs/contentitem-properties-ppreb-items-properties-t-items.md
@@ -2,25 +2,27 @@
 
 `object` ([Details](contentitem-properties-ppreb-items-properties-t-items.md))
 
-# undefined Properties
+# items Properties
 
-| Property | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                              |
-| :------- | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [c](#c)  | `array`  | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c") |
-| [s](#s)  | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s") |
-| [l](#l)  | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l") |
+| Property | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                         |
+| :------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [c](#c)  | `array`  | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c") |
+| [s](#s)  | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s") |
+| [l](#l)  | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l") |
 
 ## c
 
 page coordinates of token
 
-
 `c`
 
--   is optional
--   Type: `array`
--   cannot be null
--   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c")
+*   is optional
+
+*   Type: `array`
+
+*   cannot be null
+
+*   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c")
 
 ### c Type
 
@@ -36,13 +38,15 @@ page coordinates of token
 
 offset start (relative to ft field)
 
-
 `s`
 
--   is optional
--   Type: `number`
--   cannot be null
--   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s")
+*   is optional
+
+*   Type: `number`
+
+*   cannot be null
+
+*   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s")
 
 ### s Type
 
@@ -52,13 +56,15 @@ offset start (relative to ft field)
 
 token length
 
-
 `l`
 
--   is optional
--   Type: `number`
--   cannot be null
--   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l")
+*   is optional
+
+*   Type: `number`
+
+*   cannot be null
+
+*   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l")
 
 ### l Type
 

diff --git a/docs/contentitem-properties-ppreb-items.md b/docs/contentitem-properties-ppreb-items.md
@@ -2,25 +2,27 @@
 
 `object` ([Details](contentitem-properties-ppreb-items.md))
 
-# undefined Properties
+# items Properties
 
-| Property  | Type     | Required | Nullable       | Defined by                                                                                                                                                                                          |
-| :-------- | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [id](#id) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-id.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id") |
-| [n](#n)   | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-n.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n")   |
-| [t](#t)   | `array`  | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t")   |
+| Property  | Type     | Required | Nullable       | Defined by                                                                                                                                                                                     |
+| :-------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [id](#id) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id") |
+| [n](#n)   | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n")   |
+| [t](#t)   | `array`  | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t")   |
 
 ## id
 
 canonical ID
 
-
 `id`
 
--   is optional
--   Type: `string`
--   cannot be null
--   defined in: [Content Item](contentitem-properties-ppreb-items-properties-id.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id")
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Content Item](contentitem-properties-ppreb-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id")
 
 ### id Type
 
@@ -30,13 +32,15 @@ canonical ID
 
 page number
 
-
 `n`
 
--   is optional
--   Type: `number`
--   cannot be null
--   defined in: [Content Item](contentitem-properties-ppreb-items-properties-n.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n")
+*   is optional
+
+*   Type: `number`
+
+*   cannot be null
+
+*   defined in: [Content Item](contentitem-properties-ppreb-items-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n")
 
 ### n Type
 
@@ -46,13 +50,15 @@ page number
 
 a list of tokens
 
-
 `t`
 
--   is optional
--   Type: `object[]` ([Details](contentitem-properties-ppreb-items-properties-t-items.md))
--   cannot be null
--   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t.md "https&#x3A;//impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t")
+*   is optional
+
+*   Type: `object[]` ([Details](contentitem-properties-ppreb-items-properties-t-items.md))
+
+*   cannot be null
+
+*   defined in: [Content Item](contentitem-properties-ppreb-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t")
 
 ### t Type
 

diff --git a/docs/contentitem-properties-ts.md b/docs/contentitem-properties-ts.md
@@ -4,7 +4,7 @@
 
 ## ts Constraints
 
-**pattern**: the string must match the following regular expression: 
+**pattern**: the string must match the following regular expression:&#x20;
 
 ```regexp
 ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$