Merge pull request #17 from CommonGateway/feature/documentation-2024

Model Updates
CommonGateway · May 7, 2024 · e8ab4f8 · e8ab4f8
2 parents 096a070 + b202840
commit e8ab4f8
Show file tree

Hide file tree

Showing 72 changed files with 733 additions and 747 deletions.
diff --git a/Installation/Schema/Attachment.schema.json b/Installation/Schema/Attachment.schema.json
@@ -0,0 +1,66 @@
+{
+    "title": "Attachment",
+    "$id": "https://openwoo.app/schemas/attachment.schema.json",
+    "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
+    "version": "0.0.1",
+    "type": "object",
+    "description": "An attachment object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The unique identifier of this subject"
+        },
+        "title": {
+            "type": "string",
+            "format": "text",
+            "description": "The title (name) of a Attachment, if the title is left empty the file name wil be used instead",
+            "minLength": 25,
+            "maxLength": 255
+        },
+        "summary": {
+            "type": "string",
+            "format": "text",
+            "description": "A short summary of the subject for the overview page",
+            "minLength": 50,
+            "maxLength": 2500
+        },
+        "description": {
+            "type": "string",
+            "format": "text",
+            "description": "An extensive description of the subject for display on the subject page",
+            "maxLength": 25000
+        },
+        "labels": {
+            "type": "array",
+            "description": "Possible labels on the attachment that are used to assess what kind of file it is"
+        },
+        "url": {
+            "type": "string",
+            "format": "url",
+            "description": "The URL to the original document, this URL  should be accessible to Open Index. When there is an ‘POST` or `PUT` request to Open Index then Open Index wil try to get the original file from the URL and use it to fill the `documentText`,` type`, ` extension` and ` size` properties",
+            "required": true
+        },
+        "documentText": {
+            "type": "string",
+            "format": "text",
+            "description": "The text from the original document, which is included in the search index to facilitate searching of documents. This value is automatically updated and thus cannot be set via the API"
+        },
+        "type": {
+            "type": "string",
+            "format": "mime-type",
+            "description": "The MIME type of the attachment, determined at the time of reading and recorded for display in the UI. This value is automatically updated and thus cannot be set via the API"
+        },
+        "extension": {
+            "type": "string",
+            "description": "The extension of the attachment, determined at the time of reading and recorded for display in the UI. This value is automatically updated and thus cannot be set via the API"
+        },
+        "size": {
+            "type": "integer",
+            "description": "The size of the attachment in bytes, determined at the time of reading and recorded for display in the UI. This value is automatically updated and thus cannot be set via the API"
+        }
+    },
+    "required": [
+        "url"
+    ]
+}
diff --git a/Installation/Schema/Bijlage.schema.json b/Installation/Schema/Bijlage.schema.json
diff --git a/Installation/Schema/Index.schema.json b/Installation/Schema/Index.schema.json
@@ -4,62 +4,62 @@
     "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
     "version": "0.0.1",
     "type": "object",
-    "description": "Een extern gevonden index die als bron kan worden gebruikt bij het stellen van federatieve zoekvragen",
+    "description": "An externally found index that can be used as a source in federative search queries",
     "properties": {
         "id": {
             "type": "string",
             "format": "uuid",
-            "description":"De unieke identifier van de index"
+            "description": "The unique identifier of the index"
         },
-        "titel": {
+        "title": {
             "type": "string",
             "format": "text",
-            "description":"De titel (naam) van de index",
+            "description": "The title (name) of the index",
             "minLength": 25,
             "maxLength": 255,
             "required": true
         },
-        "samenvatting": {
+        "summary": {
             "type": "string",
             "format": "text",
-            "description":"Een korte samenvatting van de index",
+            "description": "A short summary of the index",
             "minLength": 50,
             "maxLength": 2500,
             "required": true
         },
-        "beschrijving": {
+        "description": {
             "type": "string",
             "format": "text",
-            "description":"Een uitgebreide beschrijving van de index voor weergave op de index pagina",
+            "description": "An extensive description of the index for display on the index page",
             "maxLength": 25000,
             "required": true
         },
-        "afbeelding": {
+        "image": {
             "type": "string",
-            "format": ["url","base64"],
-            "description":"Een afbeelding voor bij de index, bijvoorbeeld een logo. Mag worden opgegeven als verwijzing `url` of `base64` encoded image"
+            "format": ["url", "base64"],
+            "description": "An image for the index, such as a logo. Can be provided as a reference `url` or `base64` encoded image"
         },
         "url": {
             "type": "string",
             "format": "url",
-            "description": "De url naar de API van de index",
+            "description": "The URL to the index's API",
             "required": true
         },
         "status": {
             "type": "integer",
             "maxLength": 3,
-            "description":"De meest recente status van deze index"
+            "description": "The most recent status of this index"
         },
-        "organisatie": {
+        "organization": {
             "type": "object",
-            "$ref": "https://commongateway.nl/woo.organisatie.schema.json",
+            "$ref": "https://commongateway.nl/woo.organization.schema.json",
             "format": "json",
-            "description":"De organisatie die deze index beschickbaar stelt (fungeerd als default voor publicaties in de index)"
+            "description": "The organization that provides this index (acts as the default for publications in the index)"
         }
     },
     "required": [
-        "titel",
-        "samenvatting",
-        "beschrijving"
+        "title",
+        "summary",
+        "description"
     ]
-}
+}
diff --git a/Installation/Schema/Metadata.oc_publiccode.schema.json b/Installation/Schema/Metadata.oc_publiccode.schema.json
@@ -0,0 +1,82 @@
+{
+    "title": "Metadata Open Catalogi Publiccode",
+    "$id": "https://openwoo.app/schemas/Metadata.oc_publiccode.schema.schema.json",
+    "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
+    "version": "0.0.1",
+    "type": "object",
+    "description": "Adviezen over ontwerpen en andere onderwerpen van adviescolleges of -commissies, exclusief adviezen die betrekking hebben op individuele gevallen.",
+    "properties": {
+        "tooiCategorieNaam": {
+            "type": "string",
+            "const":"adviezen",
+            "description":"De naam van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiCategorieId": {
+            "type": "string",
+            "const":"c_99a836c7",
+            "description":"De tooiCategorieId van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiCategorieUri": {
+            "type": "string",
+            "const":"https://identifier.overheid.nl/tooi/def/thes/kern/c_99a836c7",
+            "description":"De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]`"
+        },
+        "tooiThemaNaam": {
+            "type": "string",
+            "description":"De naam van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiThemaId": {
+            "type": "string",
+            "description":"De id van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiThemaUri": {
+            "type": "string",
+            "description":"De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]`"
+        },
+        "oprdachtgever": {
+            "type": "string",
+            "description":"Gaat het om onderzoek naar het functioneren van de eigen organisatie of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ?",
+            "required": true,
+            "maxLength": 2555
+        },
+        "onderdeelTaak": {
+            "type": "string",
+            "description":"Maakt het opstellen van dit onderzoeksrapport onderdeel uit van de uitvoering van de taak van deze organisatie?",
+            "required": true,
+            "maxLength": 2555
+        },
+        "onderwerp": {
+            "type": "string",
+            "description":"Gaat het om onderzoek naar het functioneren van de eigen organisatie 0 of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ?",
+            "required": true,
+            "maxLength": 2555
+        },
+        "feitelijkMateriaal": {
+            "type": "boolean",
+            "description":"Bestaat de inhoud van het onderzoeksrapport voor het grootste deel O uit feitelijk materiaal?",
+            "required": true
+        },
+        "values": {
+            "type": "array",
+            "description":"Binnen KOOP Woo Index kunnen waardes niet uitlijnen op TOOI wel worden meegegeven in key value pair's. Deze zijn vervolgens wel doorzoekbaar maar geen onderdeel van de open.overheid.nl user interface",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "key": {
+                        "type": "string"
+                    },
+                    "value": {
+                        "type": "string"
+                    }
+                },
+                "required": ["key", "value"]
+            }
+        }
+    },
+    "required": [
+        "onderdeelTaak",
+        "oprdachtgever",
+        "onderwerp",
+        "feitelijkMateriaal"
+    ]
+}
diff --git a/Installation/Schema/Metadata.ods_agenda_item.schema.json b/Installation/Schema/Metadata.ods_agenda_item.schema.json
@@ -0,0 +1,82 @@
+{
+    "title": "Metadata Open Catalogi Publiccode",
+    "$id": "https://openwoo.app/schemas/Metadata.oc_publiccode.schema.schema.json",
+    "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
+    "version": "0.0.1",
+    "type": "object",
+    "description": "Adviezen over ontwerpen en andere onderwerpen van adviescolleges of -commissies, exclusief adviezen die betrekking hebben op individuele gevallen.",
+    "properties": {
+        "tooiCategorieNaam": {
+            "type": "string",
+            "const":"adviezen",
+            "description":"De naam van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiCategorieId": {
+            "type": "string",
+            "const":"c_99a836c7",
+            "description":"De tooiCategorieId van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiCategorieUri": {
+            "type": "string",
+            "const":"https://identifier.overheid.nl/tooi/def/thes/kern/c_99a836c7",
+            "description":"De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]`"
+        },
+        "tooiThemaNaam": {
+            "type": "string",
+            "description":"De naam van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiThemaId": {
+            "type": "string",
+            "description":"De id van de TOOI categorie conform [diwoo metadata lijsten](https://standaarden.overheid.nl/diwoo/metadata/doc/0.9.1/diwoo-metadata-lijsten_xsd_Simple_Type_diwoo_scw_woo_informatiecategorieen)"
+        },
+        "tooiThemaUri": {
+            "type": "string",
+            "description":"De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]`"
+        },
+        "oprdachtgever": {
+            "type": "string",
+            "description":"Gaat het om onderzoek naar het functioneren van de eigen organisatie of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ?",
+            "required": true,
+            "maxLength": 2555
+        },
+        "onderdeelTaak": {
+            "type": "string",
+            "description":"Maakt het opstellen van dit onderzoeksrapport onderdeel uit van de uitvoering van de taak van deze organisatie?",
+            "required": true,
+            "maxLength": 2555
+        },
+        "onderwerp": {
+            "type": "string",
+            "description":"Gaat het om onderzoek naar het functioneren van de eigen organisatie 0 of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ?",
+            "required": true,
+            "maxLength": 2555
+        },
+        "feitelijkMateriaal": {
+            "type": "boolean",
+            "description":"Bestaat de inhoud van het onderzoeksrapport voor het grootste deel O uit feitelijk materiaal?",
+            "required": true
+        },
+        "values": {
+            "type": "array",
+            "description":"Binnen KOOP Woo Index kunnen waardes niet uitlijnen op TOOI wel worden meegegeven in key value pair's. Deze zijn vervolgens wel doorzoekbaar maar geen onderdeel van de open.overheid.nl user interface",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "key": {
+                        "type": "string"
+                    },
+                    "value": {
+                        "type": "string"
+                    }
+                },
+                "required": ["key", "value"]
+            }
+        }
+    },
+    "required": [
+        "onderdeelTaak",
+        "oprdachtgever",
+        "onderwerp",
+        "feitelijkMateriaal"
+    ]
+}