From dcf92260ad7eb7259b633a6255f15e5e2a59e654 Mon Sep 17 00:00:00 2001 From: Ruben van der Linde Date: Tue, 7 May 2024 09:44:23 +0200 Subject: [PATCH 1/6] Schema update --- .../Schema/Metadata.oc_publiccode.schema.json | 82 +++++++++++++++++++ .../Metadata.ods_agenda_item.schema.json | 82 +++++++++++++++++++ docs/ORI.md | 12 ++- docs/schema/Bijlage.puml | 18 ---- ..._en_besluitenlijsten_bestuurscolleges.puml | 15 ---- ...Metadata.tooi_bereikbaarheidsgegevens.puml | 15 ---- docs/schema/Metadata.tooi_beschikkingen.puml | 15 ---- ...woordigende_organen_ingekomen_stukken.puml | 15 ---- docs/schema/Metadata.tooi_convenanten.puml | 15 ---- ...ata.tooi_jaarplannen_en_jaarverslagen.puml | 15 ---- docs/schema/Metadata.tooi_klachtoordelen.puml | 24 ------ ...wet_en_regelgeving_met_adviesaanvraag.puml | 15 ---- ...rige_besluiten_van_algemene_strekking.puml | 15 ---- ...rplichtingen_anders_dan_met_beschikking.md | 17 ---- ....tooi_vergaderstukken_staten_generaal.puml | 15 ---- .../Metadata.tooi_verzoeken_en_besluiten.puml | 18 ---- ...en_algemeen_verbindende_voorschriften.puml | 15 ---- docs/schema/Organisatie.md | 20 ----- docs/schema/Publicatie.puml | 22 ----- docs/schema/Thema.md | 16 ---- docs/schema/bijlage.md | 20 ----- docs/schema/index.md | 18 ---- docs/schema/index.puml | 16 ---- docs/schema/metadata.tooi_adviezen.md | 21 ----- docs/schema/metadata.tooi_adviezen.puml | 19 ----- ...as_en_besluitenlijsten_bestuurscolleges.md | 17 ---- .../metadata.tooi_bereikbaarheidsgegevens.md | 17 ---- docs/schema/metadata.tooi_beschikkingen.md | 17 ---- ...enwoordigende_organen_ingekomen_stukken.md | 17 ---- docs/schema/metadata.tooi_convenanten.md | 17 ---- ...adata.tooi_jaarplannen_en_jaarverslagen.md | 17 ---- docs/schema/metadata.tooi_klachtoordelen.md | 26 ------ .../metadata.tooi_onderzoeksrapporten.md | 17 ---- .../metadata.tooi_onderzoeksrapporten.puml | 15 ---- ...n_wet_en_regelgeving_met_adviesaanvraag.md | 17 ---- .../metadata.tooi_organisatie_en_werkwijze.md | 17 ---- ...etadata.tooi_organisatie_en_werkwijze.puml | 15 ---- ...verige_besluiten_van_algemene_strekking.md | 17 ---- ...lichtingen_anders_dan_met_beschikking.puml | 15 ---- ...oi_vergaderstukken_decentrale_overheden.md | 17 ---- ..._vergaderstukken_decentrale_overheden.puml | 15 ---- ...ta.tooi_vergaderstukken_staten_generaal.md | 17 ---- .../metadata.tooi_verzoeken_en_besluiten.md | 20 ----- ...n_en_algemeen_verbindende_voorschriften.md | 17 ---- docs/schema/organisatie.puml | 18 ---- docs/schema/publicatie.md | 24 ------ docs/schema/thema.puml | 14 ---- 47 files changed, 174 insertions(+), 764 deletions(-) create mode 100644 Installation/Schema/Metadata.oc_publiccode.schema.json create mode 100644 Installation/Schema/Metadata.ods_agenda_item.schema.json delete mode 100644 docs/schema/Bijlage.puml delete mode 100644 docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml delete mode 100644 docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml delete mode 100644 docs/schema/Metadata.tooi_beschikkingen.puml delete mode 100644 docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml delete mode 100644 docs/schema/Metadata.tooi_convenanten.puml delete mode 100644 docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml delete mode 100644 docs/schema/Metadata.tooi_klachtoordelen.puml delete mode 100644 docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml delete mode 100644 docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml delete mode 100644 docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md delete mode 100644 docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml delete mode 100644 docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml delete mode 100644 docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml delete mode 100644 docs/schema/Organisatie.md delete mode 100644 docs/schema/Publicatie.puml delete mode 100644 docs/schema/Thema.md delete mode 100644 docs/schema/bijlage.md delete mode 100644 docs/schema/index.md delete mode 100644 docs/schema/index.puml delete mode 100644 docs/schema/metadata.tooi_adviezen.md delete mode 100644 docs/schema/metadata.tooi_adviezen.puml delete mode 100644 docs/schema/metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.md delete mode 100644 docs/schema/metadata.tooi_bereikbaarheidsgegevens.md delete mode 100644 docs/schema/metadata.tooi_beschikkingen.md delete mode 100644 docs/schema/metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md delete mode 100644 docs/schema/metadata.tooi_convenanten.md delete mode 100644 docs/schema/metadata.tooi_jaarplannen_en_jaarverslagen.md delete mode 100644 docs/schema/metadata.tooi_klachtoordelen.md delete mode 100644 docs/schema/metadata.tooi_onderzoeksrapporten.md delete mode 100644 docs/schema/metadata.tooi_onderzoeksrapporten.puml delete mode 100644 docs/schema/metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md delete mode 100644 docs/schema/metadata.tooi_organisatie_en_werkwijze.md delete mode 100644 docs/schema/metadata.tooi_organisatie_en_werkwijze.puml delete mode 100644 docs/schema/metadata.tooi_overige_besluiten_van_algemene_strekking.md delete mode 100644 docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.puml delete mode 100644 docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.md delete mode 100644 docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.puml delete mode 100644 docs/schema/metadata.tooi_vergaderstukken_staten_generaal.md delete mode 100644 docs/schema/metadata.tooi_verzoeken_en_besluiten.md delete mode 100644 docs/schema/metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md delete mode 100644 docs/schema/organisatie.puml delete mode 100644 docs/schema/publicatie.md delete mode 100644 docs/schema/thema.puml diff --git a/Installation/Schema/Metadata.oc_publiccode.schema.json b/Installation/Schema/Metadata.oc_publiccode.schema.json new file mode 100644 index 0000000..b97e264 --- /dev/null +++ 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" + ] +} \ No newline at end of file diff --git a/Installation/Schema/Metadata.ods_agenda_item.schema.json b/Installation/Schema/Metadata.ods_agenda_item.schema.json new file mode 100644 index 0000000..b97e264 --- /dev/null +++ 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" + ] +} \ No newline at end of file diff --git a/docs/ORI.md b/docs/ORI.md index 923120f..da626c5 100644 --- a/docs/ORI.md +++ b/docs/ORI.md @@ -1,5 +1,13 @@ -# Open Raadsinformatie +# Open Raadsinformatie & Open -Conduction en Notubiz zijn aan het verkennen of Open Index gebruikt kan worden om de zelfde functionaliteit te bieden al open raads informatie zonder daarbij een nieuwe landelijke index te realiseren +Conduction en Notubiz zijn binnen de koppeling aan de WOO index van KOOP aan het verkennen of en hoe zij informatie kunnen ontsluiten richting KOOP. +aan het verkennen of Open Index gebruikt kan worden om de zelfde functionaliteit te bieden al open raads informatie zonder daarbij een nieuwe landelijke index te realiseren + +**Bronnen** +- [ORI (Depracticed)](https://github.com/ontola/ori_api) +- [ODS v2.0.0](https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie/blob/master/docs/Informatiemodel.md) +- [ODS API v2.0.0](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/ODS-Open-Raadsinformatie/master/specificatie/openapi.yaml) + +## Metadata diff --git a/docs/schema/Bijlage.puml b/docs/schema/Bijlage.puml deleted file mode 100644 index b44f9d0..0000000 --- a/docs/schema/Bijlage.puml +++ /dev/null @@ -1,18 +0,0 @@ -@startuml -title: Bijlage -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class Bijlage { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + labels: array - + url: string - + documentText: string - + type: string - + extension: string - + size: integer -} -@enduml diff --git a/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml b/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml deleted file mode 100644 index ace42e2..0000000 --- a/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIagenda’senbesluitenlijstenbestuurscolleges -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIagenda’senbesluitenlijstenbestuurscolleges { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml b/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml deleted file mode 100644 index 671d19a..0000000 --- a/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIbereikbaarheidsgegevens -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIbereikbaarheidsgegevens { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_beschikkingen.puml b/docs/schema/Metadata.tooi_beschikkingen.puml deleted file mode 100644 index 333ffa9..0000000 --- a/docs/schema/Metadata.tooi_beschikkingen.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIbeschikkingen -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIbeschikkingen { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml b/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml deleted file mode 100644 index eb918d6..0000000 --- a/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIbijvertegenwoordigendeorganeningekomenstukken -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIbijvertegenwoordigendeorganeningekomenstukken { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_convenanten.puml b/docs/schema/Metadata.tooi_convenanten.puml deleted file mode 100644 index a9bfbe5..0000000 --- a/docs/schema/Metadata.tooi_convenanten.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIconvenanten -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIconvenanten { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml b/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml deleted file mode 100644 index b5a662b..0000000 --- a/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIjaarplannenenjaarverslagen -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIjaarplannenenjaarverslagen { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_klachtoordelen.puml b/docs/schema/Metadata.tooi_klachtoordelen.puml deleted file mode 100644 index 7a8072d..0000000 --- a/docs/schema/Metadata.tooi_klachtoordelen.puml +++ /dev/null @@ -1,24 +0,0 @@ -@startuml -title: MetadataTOOIklachtoordelen -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIklachtoordelen { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + datumBesluit: string - + datumOntvangst: string - + termijnoverschrijding: string - + organisatieonderdeel: string - + functiebenaming: string - + gedraging: string - + bevindingen: string - + oordeel: string - + conclusies: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml b/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml deleted file mode 100644 index 5517af9..0000000 --- a/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraag -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraag { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml b/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml deleted file mode 100644 index 75c2ac9..0000000 --- a/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIoverigebesluitenvanalgemenestrekking -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIoverigebesluitenvanalgemenestrekking { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md b/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md deleted file mode 100644 index 69028e0..0000000 --- a/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI subsidieverplichtingen anders dan met beschikking - -Subsidieverplichtingen die niet via een beschikking lopen, specifiek bij Ministerie van Binnenlandse Zaken. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml b/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml deleted file mode 100644 index 9147545..0000000 --- a/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIvergaderstukkenStaten-Generaal -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIvergaderstukkenStaten-Generaal { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml b/docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml deleted file mode 100644 index 0b573e8..0000000 --- a/docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml +++ /dev/null @@ -1,18 +0,0 @@ -@startuml -title: MetadataTOOIWoo-verzoekenen-besluiten -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIWoo-verzoekenen-besluiten { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + datumBesluit: string - + datumOntvangst: string - + termijnoverschrijding: string - + values: array -} -@enduml diff --git a/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml b/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml deleted file mode 100644 index 8e8c593..0000000 --- a/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIwettenenalgemeenverbindendevoorschriften -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIwettenenalgemeenverbindendevoorschriften { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/Organisatie.md b/docs/schema/Organisatie.md deleted file mode 100644 index 41c492c..0000000 --- a/docs/schema/Organisatie.md +++ /dev/null @@ -1,20 +0,0 @@ -# Organisatie - -Een organisatie die een publicatie of index ter beschicking steld - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Organisatie.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| id | string | De unieke identifier deze organisatie | No | -| titel | string | De titel (naam) van een onderwerp | Yes | -| samenvatting | string | Een korte samenvatting van het onderwerp voor op de overzichts pagina | Yes | -| beschrijving | string | Een uitgebreide beschrijving van het onderwerp voor weergave op de onderwerp pagina | Yes | -| afbeelding | string | Een afbeelding voor bij het onderwerp, mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | -| uuid | string | N/A | No | -| oin | string | N/A | No | -| tooi | string | N/A | No | -| rsin | string | N/A | No | -| naam | string | N/A | No | diff --git a/docs/schema/Publicatie.puml b/docs/schema/Publicatie.puml deleted file mode 100644 index c68d066..0000000 --- a/docs/schema/Publicatie.puml +++ /dev/null @@ -1,22 +0,0 @@ -@startuml -title: Publicatie -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class Publicatie { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + categorie: string - + portal: string - + publicatiedatum: string - + featured: boolean - + organisatie: object - + schema: string - + bijlagen: array - + onderwerp: object - + data: object -} -@enduml diff --git a/docs/schema/Thema.md b/docs/schema/Thema.md deleted file mode 100644 index 07c7d35..0000000 --- a/docs/schema/Thema.md +++ /dev/null @@ -1,16 +0,0 @@ -# Thema - -Een thematische clustering van publicaties in voor de zoeken logische manier, kan bijvoorbeeld ook worden gebruikt voor onderwerpen - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Thema.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| id | string | De unieke identifier van dit thema | No | -| titel | string | De titel (naam) van een thema | Yes | -| samenvatting | string | Een korte samenvatting van het thema voor op de overzichts pagina | Yes | -| beschrijving | string | Een uitgebreide beschrijving van het thema voor weergave op de thema pagina | No | -| afbeelding | string | Een afbeelding voor bij het thema, mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | -| publicaties | integer | Het aantal publicaties dat bij dit thema hoort | No | diff --git a/docs/schema/bijlage.md b/docs/schema/bijlage.md deleted file mode 100644 index ff32f51..0000000 --- a/docs/schema/bijlage.md +++ /dev/null @@ -1,20 +0,0 @@ -# Bijlage - -H - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/bijlage.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| id | string | De unieke identifier van dit onderwerp | No | -| titel | string | De titel (naam) van een onderwerp | Yes | -| samenvatting | string | Een korte samenvatting van het onderwerp voor op de overzichts pagina | Yes | -| beschrijving | string | Een uitgebreide beschrijving van het onderwerp voor weergave op de onderwerp pagina | No | -| labels | array | Eventueele labels op de bijlage doe worden gebruikt voor het beoordelen om wat voor een bestand het gaat | No | -| url | string | De url naar het oorspronklenlijke document | Yes | -| documentText | string | De tekst uit het oorspronkenlijke document, deze wordt opgenomen in de zoek index om het doorzoeken van documenten te faciliteren | No | -| type | string | Het mime-type van de bijlage, wordt bepaald bij inlezen en opgenomen voor weergave in de ui | No | -| extension | string | De extensie van de bijlage, wordt bepaald bij inlezen en opgenomen voor weergave in de ui | No | -| size | integer | De grote van de bijlage in bytes, wordt bepaald bij inlezen en opgenomen voor weergave in de ui | No | diff --git a/docs/schema/index.md b/docs/schema/index.md deleted file mode 100644 index 04098c7..0000000 --- a/docs/schema/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# Index - -Een extern gevonden index die als bron kan worden gebruikt bij het stellen van federatieve zoekvragen - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/index.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| id | string | De unieke identifier van de index | No | -| titel | string | De titel (naam) van de index | Yes | -| samenvatting | string | Een korte samenvatting van de index | Yes | -| beschrijving | string | Een uitgebreide beschrijving van de index voor weergave op de index pagina | Yes | -| afbeelding | string | Een afbeelding voor bij de index, bijvoorbeeld een logo. Mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | -| url | string | De url naar de API van de index | No | -| status | integer | De meest recente status van deze index | No | -| organisatie | object | De organisatie die deze index beschickbaar stelt (fungeerd als default voor publicaties in de index) | No | diff --git a/docs/schema/index.puml b/docs/schema/index.puml deleted file mode 100644 index 35fecd1..0000000 --- a/docs/schema/index.puml +++ /dev/null @@ -1,16 +0,0 @@ -@startuml -title: Index -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class Index { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + url: string - + status: integer - + organisatie: object -} -@enduml diff --git a/docs/schema/metadata.tooi_adviezen.md b/docs/schema/metadata.tooi_adviezen.md deleted file mode 100644 index e5e6d74..0000000 --- a/docs/schema/metadata.tooi_adviezen.md +++ /dev/null @@ -1,21 +0,0 @@ -# Metadata TOOI adviezen - -Adviezen over ontwerpen en andere onderwerpen van adviescolleges of -commissies, exclusief adviezen die betrekking hebben op individuele gevallen. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_adviezen.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| oprdachtgever | string | Gaat het om onderzoek naar het functioneren van de eigen organisatie of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ? | Yes | -| onderdeelTaak | string | Maakt het opstellen van dit onderzoeksrapport onderdeel uit van de uitvoering van de taak van deze organisatie? | Yes | -| onderwerp | string | Gaat het om onderzoek naar het functioneren van de eigen organisatie 0 of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ? | Yes | -| feitelijkMateriaal | boolean | Bestaat de inhoud van het onderzoeksrapport voor het grootste deel O uit feitelijk materiaal? | Yes | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_adviezen.puml b/docs/schema/metadata.tooi_adviezen.puml deleted file mode 100644 index f43a0ef..0000000 --- a/docs/schema/metadata.tooi_adviezen.puml +++ /dev/null @@ -1,19 +0,0 @@ -@startuml -title: MetadataTOOIadviezen -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIadviezen { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + oprdachtgever: string - + onderdeelTaak: string - + onderwerp: string - + feitelijkMateriaal: boolean - + values: array -} -@enduml diff --git a/docs/schema/metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.md b/docs/schema/metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.md deleted file mode 100644 index 26258a9..0000000 --- a/docs/schema/metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI agenda’s en besluitenlijsten bestuurscolleges - -Agenda’s en besluitenlijsten van vergaderingen van diverse bestuurlijke organen. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_bereikbaarheidsgegevens.md b/docs/schema/metadata.tooi_bereikbaarheidsgegevens.md deleted file mode 100644 index ee8975d..0000000 --- a/docs/schema/metadata.tooi_bereikbaarheidsgegevens.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI bereikbaarheidsgegevens - -Bereikbaarheidsinformatie van bestuursorganen en hun organisatieonderdelen. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_bereikbaarheidsgegevens.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_beschikkingen.md b/docs/schema/metadata.tooi_beschikkingen.md deleted file mode 100644 index c22e6fe..0000000 --- a/docs/schema/metadata.tooi_beschikkingen.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI beschikkingen - -Beschikkingen, uitgezonderd specifieke categorieën. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_beschikkingen.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md b/docs/schema/metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md deleted file mode 100644 index f8b6c2d..0000000 --- a/docs/schema/metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI bij vertegenwoordigende organen ingekomen stukken - -Ingekomen stukken bij diverse overheidsorganen, uitgezonderd bepaalde vertrouwelijke informatie of individuele gevallen. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_convenanten.md b/docs/schema/metadata.tooi_convenanten.md deleted file mode 100644 index d1b1206..0000000 --- a/docs/schema/metadata.tooi_convenanten.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI convenanten - -Convenanten. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_convenanten.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_jaarplannen_en_jaarverslagen.md b/docs/schema/metadata.tooi_jaarplannen_en_jaarverslagen.md deleted file mode 100644 index f0ee382..0000000 --- a/docs/schema/metadata.tooi_jaarplannen_en_jaarverslagen.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI jaarplannen en jaarverslagen - -Jaarplannen en jaarverslagen van bestuursorganen over hun taakuitvoering. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_jaarplannen_en_jaarverslagen.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_klachtoordelen.md b/docs/schema/metadata.tooi_klachtoordelen.md deleted file mode 100644 index 8893ee8..0000000 --- a/docs/schema/metadata.tooi_klachtoordelen.md +++ /dev/null @@ -1,26 +0,0 @@ -# Metadata TOOI klachtoordelen - -Schriftelijke oordelen in klachtprocedures. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_klachtoordelen.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| datumBesluit | string | Wanneer is er over de klacht besloten | Yes | -| datumOntvangst | string | Wanneer is de klacht binnen gekomen | Yes | -| termijnoverschrijding | string | Een (evenuteel) overschrijding van het beantwoordings termijn termijn | No | -| organisatieonderdeel | string | | No | -| functiebenaming | string | | No | -| gedraging | string | | No | -| bevindingen | string | | No | -| oordeel | string | | No | -| conclusies | string | | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_onderzoeksrapporten.md b/docs/schema/metadata.tooi_onderzoeksrapporten.md deleted file mode 100644 index 4ce20b2..0000000 --- a/docs/schema/metadata.tooi_onderzoeksrapporten.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI onderzoeksrapporten - -Onderzoeksrapporten opgesteld op verzoek van bestuursorganen die geen taakuitvoering zijn, gericht op organisatie of beleidsevaluatie. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_onderzoeksrapporten.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_onderzoeksrapporten.puml b/docs/schema/metadata.tooi_onderzoeksrapporten.puml deleted file mode 100644 index 4e46dea..0000000 --- a/docs/schema/metadata.tooi_onderzoeksrapporten.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIonderzoeksrapporten -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIonderzoeksrapporten { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md b/docs/schema/metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md deleted file mode 100644 index 5aa40f0..0000000 --- a/docs/schema/metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI ontwerpen van wet- en regelgeving met adviesaanvraag - -Ontwerpen van wetgeving waarover extern advies is gevraagd, inclusief de adviesaanvraag. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_organisatie_en_werkwijze.md b/docs/schema/metadata.tooi_organisatie_en_werkwijze.md deleted file mode 100644 index 3bbc60d..0000000 --- a/docs/schema/metadata.tooi_organisatie_en_werkwijze.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI organisatie en werkwijze - -Informatie over de organisatie en werkwijze van bestuursorganen. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_organisatie_en_werkwijze.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_organisatie_en_werkwijze.puml b/docs/schema/metadata.tooi_organisatie_en_werkwijze.puml deleted file mode 100644 index 2241355..0000000 --- a/docs/schema/metadata.tooi_organisatie_en_werkwijze.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIorganisatieenwerkwijze -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIorganisatieenwerkwijze { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/metadata.tooi_overige_besluiten_van_algemene_strekking.md b/docs/schema/metadata.tooi_overige_besluiten_van_algemene_strekking.md deleted file mode 100644 index b77a970..0000000 --- a/docs/schema/metadata.tooi_overige_besluiten_van_algemene_strekking.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI overige besluiten van algemene strekking - -Overige besluiten van algemene strekking. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_overige_besluiten_van_algemene_strekking.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.puml b/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.puml deleted file mode 100644 index 3719c2d..0000000 --- a/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIsubsidieverplichtingenandersdanmetbeschikking -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIsubsidieverplichtingenandersdanmetbeschikking { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.md b/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.md deleted file mode 100644 index 758c1b9..0000000 --- a/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI vergaderstukken decentrale overheden - -Vergaderstukken en verslagen van diverse decentrale overheden en hun commissies. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.puml b/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.puml deleted file mode 100644 index 405511d..0000000 --- a/docs/schema/metadata.tooi_vergaderstukken_decentrale_overheden.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title: MetadataTOOIvergaderstukkendecentraleoverheden -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class MetadataTOOIvergaderstukkendecentraleoverheden { - + tooiCategorieNaam: string - + tooiCategorieId: string - + tooiCategorieUri: string - + tooiThemaNaam: string - + tooiThemaId: string - + tooiThemaUri: string - + values: array -} -@enduml diff --git a/docs/schema/metadata.tooi_vergaderstukken_staten_generaal.md b/docs/schema/metadata.tooi_vergaderstukken_staten_generaal.md deleted file mode 100644 index 7d3821a..0000000 --- a/docs/schema/metadata.tooi_vergaderstukken_staten_generaal.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI vergaderstukken Staten-Generaal - -Vergaderstukken en verslagen van de Staten-Generaal, uitgezonderd vertrouwelijke informatie verstrekt aan de Staten-Generaal. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_vergaderstukken_staten_generaal.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_verzoeken_en_besluiten.md b/docs/schema/metadata.tooi_verzoeken_en_besluiten.md deleted file mode 100644 index 3a32f12..0000000 --- a/docs/schema/metadata.tooi_verzoeken_en_besluiten.md +++ /dev/null @@ -1,20 +0,0 @@ -# Metadata TOOI Woo-verzoeken en -besluiten - -Inhoud van schriftelijke Woo-verzoeken en besluiten daarop, inclusief verstrekte informatie. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_verzoeken_en_besluiten.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| datumBesluit | string | Wanneer is er over het verzoek besloten | Yes | -| datumOntvangst | string | Wanneer is het verzoek binnen gekomen | Yes | -| termijnoverschrijding | string | Een (evenuteel) overschrijding van het beantwoordings termijn termijn | No | -| values | array | 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 | No | diff --git a/docs/schema/metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md b/docs/schema/metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md deleted file mode 100644 index baf6300..0000000 --- a/docs/schema/metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md +++ /dev/null @@ -1,17 +0,0 @@ -# Metadata TOOI wetten en algemeen verbindende voorschriften - -Wetten en andere algemeen verbindende voorschriften. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| tooiCategorieNaam | string | 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) | No | -| tooiCategorieId | string | 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) | No | -| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | -| tooiThemaNaam | string | 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) | No | -| tooiThemaId | string | 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) | No | -| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | -| values | array | 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 | No | diff --git a/docs/schema/organisatie.puml b/docs/schema/organisatie.puml deleted file mode 100644 index 30936c4..0000000 --- a/docs/schema/organisatie.puml +++ /dev/null @@ -1,18 +0,0 @@ -@startuml -title: Organisatie -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class Organisatie { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + uuid: string - + oin: string - + tooi: string - + rsin: string - + naam: string -} -@enduml diff --git a/docs/schema/publicatie.md b/docs/schema/publicatie.md deleted file mode 100644 index 3f2902b..0000000 --- a/docs/schema/publicatie.md +++ /dev/null @@ -1,24 +0,0 @@ -# Publicatie - -Het publicatie object vormt de kern van Open Index, het fungeert als een metadata wrapper voor objecten en vormt daarmee het gemeen schappenlijk verband tussen de verschillende publcaties uit bijvoorbeeld de WOO en OC. - -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/publicatie.svg) - -## Properties - -| Property | Type | Description | Required | -|----------|------|-------------|----------| -| id | string | De unieke identifier van deze publicatie | No | -| titel | string | De titel (naam) van een publicatie | Yes | -| samenvatting | string | Een korte samenvatting van de publicatie voor op de overzichts pagina | Yes | -| beschrijving | string | Een uitgebreide beschrijving van de publicatie voor weergave op de publicatie pagina | Yes | -| afbeelding | string | Een afbeelding voor bij de publicatie, mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | -| categorie | string | De categorie waarbinnen de publicatie valt, dit kunnen zelf gedefineerde categorien zijn of vooraf gedefineerd categorien | Yes | -| portal | string | Een optionele verwijzing naar een afwijkende publicatie pagina, bijvoorbeeld in het RIS | No | -| publicatiedatum | string | Datum vanaf wanneer deze publicatie vindbaar moet zijn, dit mag een datum in de toekomst of verleden zijn. Publicaties waarbij deze datum in de toekomst ligt of leeg is worden NIET weergegeven | No | -| featured | boolean | Datum vanaf wanneer deze publicatie vindbaar moet zijn, dit mag een datum in de toekomst of verleden zijn. Publicaties waarbij deze datum in de toekomst ligt of leeg is worden NIET weergegeven | No | -| organisatie | object | De organisatie horende bij dit publicatie object, in theorie kunnen meerdere organisaties één Open Index installatie delen maar we ontraden dit. | No | -| schema | string | Een publiek toegankenlijke verwijzing naar het object type (in schema.json) van de gepubliceerde data. Deze word zowel gebruikt om de aangeleverde data te valideren als eventueele afnemers te voorzien van context over de gevonden data | No | -| bijlagen | array | N/A | No | -| onderwerp | object | N/A | No | -| data | object | Het daad werkenlijk te publiceren object (mag niet groter zijn dan 15 mb) | No | diff --git a/docs/schema/thema.puml b/docs/schema/thema.puml deleted file mode 100644 index 6416787..0000000 --- a/docs/schema/thema.puml +++ /dev/null @@ -1,14 +0,0 @@ -@startuml -title: Thema -footer: Common Gateway Plugin | Commongateway | Openindex -header: Schema - -class Thema { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + publicaties: integer -} -@enduml From 92572c2b5fc5697f490fda9a6ed3efd6d166d18e Mon Sep 17 00:00:00 2001 From: Ruben van der Linde Date: Tue, 7 May 2024 09:45:22 +0200 Subject: [PATCH 2/6] Class diagrams updates --- ...ta.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md | 2 +- docs/schema/organisatie.md | 2 +- docs/schema/thema.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md b/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md index 199e533..69028e0 100644 --- a/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md +++ b/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md @@ -2,7 +2,7 @@ Subsidieverplichtingen die niet via een beschikking lopen, specifiek bij Ministerie van Binnenlandse Zaken. -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.svg) +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.svg) ## Properties diff --git a/docs/schema/organisatie.md b/docs/schema/organisatie.md index 668fb8a..41c492c 100644 --- a/docs/schema/organisatie.md +++ b/docs/schema/organisatie.md @@ -2,7 +2,7 @@ Een organisatie die een publicatie of index ter beschicking steld -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/organisatie.svg) +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Organisatie.svg) ## Properties diff --git a/docs/schema/thema.md b/docs/schema/thema.md index 37a5068..07c7d35 100644 --- a/docs/schema/thema.md +++ b/docs/schema/thema.md @@ -2,7 +2,7 @@ Een thematische clustering van publicaties in voor de zoeken logische manier, kan bijvoorbeeld ook worden gebruikt voor onderwerpen -![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/thema.svg) +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Thema.svg) ## Properties From d5ab1840fb285908e07c2439336ec4d13674ce89 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 7 May 2024 07:45:59 +0000 Subject: [PATCH 3/6] Add generated puml,svg,md and README files based on plugin installation files --- docs/schema/Bijlage.puml | 18 +++++++++++++ docs/schema/Metadata.oc_publiccode.md | 21 +++++++++++++++ docs/schema/Metadata.oc_publiccode.puml | 19 ++++++++++++++ docs/schema/Metadata.ods_agenda_item.md | 21 +++++++++++++++ docs/schema/Metadata.ods_agenda_item.puml | 19 ++++++++++++++ ..._en_besluitenlijsten_bestuurscolleges.puml | 15 +++++++++++ ...Metadata.tooi_bereikbaarheidsgegevens.puml | 15 +++++++++++ docs/schema/Metadata.tooi_beschikkingen.puml | 15 +++++++++++ ...woordigende_organen_ingekomen_stukken.puml | 15 +++++++++++ docs/schema/Metadata.tooi_convenanten.puml | 15 +++++++++++ ...ata.tooi_jaarplannen_en_jaarverslagen.puml | 15 +++++++++++ docs/schema/Metadata.tooi_klachtoordelen.puml | 24 +++++++++++++++++ ...wet_en_regelgeving_met_adviesaanvraag.puml | 15 +++++++++++ ...rige_besluiten_van_algemene_strekking.puml | 15 +++++++++++ ...rplichtingen_anders_dan_met_beschikking.md | 17 ++++++++++++ ....tooi_vergaderstukken_staten_generaal.puml | 15 +++++++++++ .../Metadata.tooi_verzoeken_en_besluiten.puml | 18 +++++++++++++ ...en_algemeen_verbindende_voorschriften.puml | 15 +++++++++++ docs/schema/Organisatie.md | 20 ++++++++++++++ docs/schema/Publicatie.puml | 22 ++++++++++++++++ docs/schema/README.md | 2 ++ docs/schema/Thema.md | 16 ++++++++++++ docs/schema/all_schema_classes.puml | 26 +++++++++++++++++++ 23 files changed, 393 insertions(+) create mode 100644 docs/schema/Bijlage.puml create mode 100644 docs/schema/Metadata.oc_publiccode.md create mode 100644 docs/schema/Metadata.oc_publiccode.puml create mode 100644 docs/schema/Metadata.ods_agenda_item.md create mode 100644 docs/schema/Metadata.ods_agenda_item.puml create mode 100644 docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml create mode 100644 docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml create mode 100644 docs/schema/Metadata.tooi_beschikkingen.puml create mode 100644 docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml create mode 100644 docs/schema/Metadata.tooi_convenanten.puml create mode 100644 docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml create mode 100644 docs/schema/Metadata.tooi_klachtoordelen.puml create mode 100644 docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml create mode 100644 docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml create mode 100644 docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md create mode 100644 docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml create mode 100644 docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml create mode 100644 docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml create mode 100644 docs/schema/Organisatie.md create mode 100644 docs/schema/Publicatie.puml create mode 100644 docs/schema/Thema.md diff --git a/docs/schema/Bijlage.puml b/docs/schema/Bijlage.puml new file mode 100644 index 0000000..b44f9d0 --- /dev/null +++ b/docs/schema/Bijlage.puml @@ -0,0 +1,18 @@ +@startuml +title: Bijlage +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class Bijlage { + + id: string + + titel: string + + samenvatting: string + + beschrijving: string + + labels: array + + url: string + + documentText: string + + type: string + + extension: string + + size: integer +} +@enduml diff --git a/docs/schema/Metadata.oc_publiccode.md b/docs/schema/Metadata.oc_publiccode.md new file mode 100644 index 0000000..32ce61e --- /dev/null +++ b/docs/schema/Metadata.oc_publiccode.md @@ -0,0 +1,21 @@ +# Metadata Open Catalogi Publiccode + +Adviezen over ontwerpen en andere onderwerpen van adviescolleges of -commissies, exclusief adviezen die betrekking hebben op individuele gevallen. + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Metadata.oc_publiccode.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| tooiCategorieNaam | string | 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) | No | +| tooiCategorieId | string | 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) | No | +| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | +| tooiThemaNaam | string | 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) | No | +| tooiThemaId | string | 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) | No | +| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | +| oprdachtgever | string | Gaat het om onderzoek naar het functioneren van de eigen organisatie of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ? | Yes | +| onderdeelTaak | string | Maakt het opstellen van dit onderzoeksrapport onderdeel uit van de uitvoering van de taak van deze organisatie? | Yes | +| onderwerp | string | Gaat het om onderzoek naar het functioneren van de eigen organisatie 0 of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ? | Yes | +| feitelijkMateriaal | boolean | Bestaat de inhoud van het onderzoeksrapport voor het grootste deel O uit feitelijk materiaal? | Yes | +| values | array | 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 | No | diff --git a/docs/schema/Metadata.oc_publiccode.puml b/docs/schema/Metadata.oc_publiccode.puml new file mode 100644 index 0000000..1ef67c2 --- /dev/null +++ b/docs/schema/Metadata.oc_publiccode.puml @@ -0,0 +1,19 @@ +@startuml +title: MetadataOpenCatalogiPubliccode +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataOpenCatalogiPubliccode { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + oprdachtgever: string + + onderdeelTaak: string + + onderwerp: string + + feitelijkMateriaal: boolean + + values: array +} +@enduml diff --git a/docs/schema/Metadata.ods_agenda_item.md b/docs/schema/Metadata.ods_agenda_item.md new file mode 100644 index 0000000..543c18a --- /dev/null +++ b/docs/schema/Metadata.ods_agenda_item.md @@ -0,0 +1,21 @@ +# Metadata Open Catalogi Publiccode + +Adviezen over ontwerpen en andere onderwerpen van adviescolleges of -commissies, exclusief adviezen die betrekking hebben op individuele gevallen. + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Metadata.ods_agenda_item.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| tooiCategorieNaam | string | 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) | No | +| tooiCategorieId | string | 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) | No | +| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | +| tooiThemaNaam | string | 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) | No | +| tooiThemaId | string | 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) | No | +| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | +| oprdachtgever | string | Gaat het om onderzoek naar het functioneren van de eigen organisatie of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ? | Yes | +| onderdeelTaak | string | Maakt het opstellen van dit onderzoeksrapport onderdeel uit van de uitvoering van de taak van deze organisatie? | Yes | +| onderwerp | string | Gaat het om onderzoek naar het functioneren van de eigen organisatie 0 of om onderzoek ter voorbereiding of evaluatie van beleid of uitvoering ? | Yes | +| feitelijkMateriaal | boolean | Bestaat de inhoud van het onderzoeksrapport voor het grootste deel O uit feitelijk materiaal? | Yes | +| values | array | 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 | No | diff --git a/docs/schema/Metadata.ods_agenda_item.puml b/docs/schema/Metadata.ods_agenda_item.puml new file mode 100644 index 0000000..1ef67c2 --- /dev/null +++ b/docs/schema/Metadata.ods_agenda_item.puml @@ -0,0 +1,19 @@ +@startuml +title: MetadataOpenCatalogiPubliccode +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataOpenCatalogiPubliccode { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + oprdachtgever: string + + onderdeelTaak: string + + onderwerp: string + + feitelijkMateriaal: boolean + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml b/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml new file mode 100644 index 0000000..ace42e2 --- /dev/null +++ b/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIagenda’senbesluitenlijstenbestuurscolleges +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIagenda’senbesluitenlijstenbestuurscolleges { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml b/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml new file mode 100644 index 0000000..671d19a --- /dev/null +++ b/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIbereikbaarheidsgegevens +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIbereikbaarheidsgegevens { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_beschikkingen.puml b/docs/schema/Metadata.tooi_beschikkingen.puml new file mode 100644 index 0000000..333ffa9 --- /dev/null +++ b/docs/schema/Metadata.tooi_beschikkingen.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIbeschikkingen +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIbeschikkingen { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml b/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml new file mode 100644 index 0000000..eb918d6 --- /dev/null +++ b/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIbijvertegenwoordigendeorganeningekomenstukken +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIbijvertegenwoordigendeorganeningekomenstukken { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_convenanten.puml b/docs/schema/Metadata.tooi_convenanten.puml new file mode 100644 index 0000000..a9bfbe5 --- /dev/null +++ b/docs/schema/Metadata.tooi_convenanten.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIconvenanten +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIconvenanten { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml b/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml new file mode 100644 index 0000000..b5a662b --- /dev/null +++ b/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIjaarplannenenjaarverslagen +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIjaarplannenenjaarverslagen { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_klachtoordelen.puml b/docs/schema/Metadata.tooi_klachtoordelen.puml new file mode 100644 index 0000000..7a8072d --- /dev/null +++ b/docs/schema/Metadata.tooi_klachtoordelen.puml @@ -0,0 +1,24 @@ +@startuml +title: MetadataTOOIklachtoordelen +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIklachtoordelen { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + datumBesluit: string + + datumOntvangst: string + + termijnoverschrijding: string + + organisatieonderdeel: string + + functiebenaming: string + + gedraging: string + + bevindingen: string + + oordeel: string + + conclusies: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml b/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml new file mode 100644 index 0000000..5517af9 --- /dev/null +++ b/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraag +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraag { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml b/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml new file mode 100644 index 0000000..75c2ac9 --- /dev/null +++ b/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIoverigebesluitenvanalgemenestrekking +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIoverigebesluitenvanalgemenestrekking { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md b/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md new file mode 100644 index 0000000..69028e0 --- /dev/null +++ b/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md @@ -0,0 +1,17 @@ +# Metadata TOOI subsidieverplichtingen anders dan met beschikking + +Subsidieverplichtingen die niet via een beschikking lopen, specifiek bij Ministerie van Binnenlandse Zaken. + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| tooiCategorieNaam | string | 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) | No | +| tooiCategorieId | string | 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) | No | +| tooiCategorieUri | string | De id van de categorie voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiCategorieId]` | No | +| tooiThemaNaam | string | 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) | No | +| tooiThemaId | string | 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) | No | +| tooiThemaUri | string | De tooiThemaId van het thema voorafgegaan door `https://identifier.overheid.nl/tooi/def/thes/kern/[tooiThemaId]` | No | +| values | array | 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 | No | diff --git a/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml b/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml new file mode 100644 index 0000000..9147545 --- /dev/null +++ b/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIvergaderstukkenStaten-Generaal +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIvergaderstukkenStaten-Generaal { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml b/docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml new file mode 100644 index 0000000..0b573e8 --- /dev/null +++ b/docs/schema/Metadata.tooi_verzoeken_en_besluiten.puml @@ -0,0 +1,18 @@ +@startuml +title: MetadataTOOIWoo-verzoekenen-besluiten +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIWoo-verzoekenen-besluiten { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + datumBesluit: string + + datumOntvangst: string + + termijnoverschrijding: string + + values: array +} +@enduml diff --git a/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml b/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml new file mode 100644 index 0000000..8e8c593 --- /dev/null +++ b/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.puml @@ -0,0 +1,15 @@ +@startuml +title: MetadataTOOIwettenenalgemeenverbindendevoorschriften +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class MetadataTOOIwettenenalgemeenverbindendevoorschriften { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + values: array +} +@enduml diff --git a/docs/schema/Organisatie.md b/docs/schema/Organisatie.md new file mode 100644 index 0000000..41c492c --- /dev/null +++ b/docs/schema/Organisatie.md @@ -0,0 +1,20 @@ +# Organisatie + +Een organisatie die een publicatie of index ter beschicking steld + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Organisatie.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| id | string | De unieke identifier deze organisatie | No | +| titel | string | De titel (naam) van een onderwerp | Yes | +| samenvatting | string | Een korte samenvatting van het onderwerp voor op de overzichts pagina | Yes | +| beschrijving | string | Een uitgebreide beschrijving van het onderwerp voor weergave op de onderwerp pagina | Yes | +| afbeelding | string | Een afbeelding voor bij het onderwerp, mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | +| uuid | string | N/A | No | +| oin | string | N/A | No | +| tooi | string | N/A | No | +| rsin | string | N/A | No | +| naam | string | N/A | No | diff --git a/docs/schema/Publicatie.puml b/docs/schema/Publicatie.puml new file mode 100644 index 0000000..c68d066 --- /dev/null +++ b/docs/schema/Publicatie.puml @@ -0,0 +1,22 @@ +@startuml +title: Publicatie +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class Publicatie { + + id: string + + titel: string + + samenvatting: string + + beschrijving: string + + afbeelding: string + + categorie: string + + portal: string + + publicatiedatum: string + + featured: boolean + + organisatie: object + + schema: string + + bijlagen: array + + onderwerp: object + + data: object +} +@enduml diff --git a/docs/schema/README.md b/docs/schema/README.md index a15649b..9a4064e 100644 --- a/docs/schema/README.md +++ b/docs/schema/README.md @@ -5,11 +5,13 @@ | Class | Documentation | |-------|--------------| | Metadata TOOI wetten en algemeen verbindende voorschriften | [Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md](Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md) | +| Metadata Open Catalogi Publiccode | [Metadata.ods_agenda_item.md](Metadata.ods_agenda_item.md) | | Publicatie | [Publicatie.md](Publicatie.md) | | Metadata TOOI ontwerpen van wet- en regelgeving met adviesaanvraag | [Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md](Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md) | | Metadata TOOI vergaderstukken decentrale overheden | [Metadata.tooi_vergaderstukken_decentrale_overheden.md](Metadata.tooi_vergaderstukken_decentrale_overheden.md) | | Metadata TOOI bij vertegenwoordigende organen ingekomen stukken | [Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md](Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md) | | Thema | [Thema.md](Thema.md) | +| Metadata Open Catalogi Publiccode | [Metadata.oc_publiccode.md](Metadata.oc_publiccode.md) | | Metadata TOOI overige besluiten van algemene strekking | [Metadata.tooi_overige_besluiten_van_algemene_strekking.md](Metadata.tooi_overige_besluiten_van_algemene_strekking.md) | | Metadata TOOI onderzoeksrapporten | [Metadata.tooi_onderzoeksrapporten.md](Metadata.tooi_onderzoeksrapporten.md) | | Metadata TOOI convenanten | [Metadata.tooi_convenanten.md](Metadata.tooi_convenanten.md) | diff --git a/docs/schema/Thema.md b/docs/schema/Thema.md new file mode 100644 index 0000000..07c7d35 --- /dev/null +++ b/docs/schema/Thema.md @@ -0,0 +1,16 @@ +# Thema + +Een thematische clustering van publicaties in voor de zoeken logische manier, kan bijvoorbeeld ook worden gebruikt voor onderwerpen + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Thema.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| id | string | De unieke identifier van dit thema | No | +| titel | string | De titel (naam) van een thema | Yes | +| samenvatting | string | Een korte samenvatting van het thema voor op de overzichts pagina | Yes | +| beschrijving | string | Een uitgebreide beschrijving van het thema voor weergave op de thema pagina | No | +| afbeelding | string | Een afbeelding voor bij het thema, mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | +| publicaties | integer | Het aantal publicaties dat bij dit thema hoort | No | diff --git a/docs/schema/all_schema_classes.puml b/docs/schema/all_schema_classes.puml index 21c581f..39aa8f0 100644 --- a/docs/schema/all_schema_classes.puml +++ b/docs/schema/all_schema_classes.puml @@ -11,6 +11,19 @@ class MetadataTOOIwettenenalgemeenverbindendevoorschriften { + tooiThemaUri: string + values: array } +class MetadataOpenCatalogiPubliccode { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + oprdachtgever: string + + onderdeelTaak: string + + onderwerp: string + + feitelijkMateriaal: boolean + + values: array +} class Publicatie { + id: string + titel: string @@ -62,6 +75,19 @@ class Thema { + afbeelding: string + publicaties: integer } +class MetadataOpenCatalogiPubliccode { + + tooiCategorieNaam: string + + tooiCategorieId: string + + tooiCategorieUri: string + + tooiThemaNaam: string + + tooiThemaId: string + + tooiThemaUri: string + + oprdachtgever: string + + onderdeelTaak: string + + onderwerp: string + + feitelijkMateriaal: boolean + + values: array +} class MetadataTOOIoverigebesluitenvanalgemenestrekking { + tooiCategorieNaam: string + tooiCategorieId: string From 08a91cc488ea98c8f0011c935cd3684079b242e8 Mon Sep 17 00:00:00 2001 From: Ruben van der Linde Date: Tue, 7 May 2024 22:27:39 +0200 Subject: [PATCH 4/6] Switch to englisch for primairy objects --- Installation/Schema/Attachment.schema.json | 66 ++++++++++++ Installation/Schema/Bijlage.schema.json | 70 ------------ Installation/Schema/Index.schema.json | 40 +++---- ...e.schema.json => Organization.schema.json} | 38 ++++--- Installation/Schema/Publicatie.schema.json | 102 ------------------ Installation/Schema/Publication.schema.json | 100 +++++++++++++++++ Installation/Schema/Thema.schema.json | 51 --------- Installation/Schema/Theme.schema.json | 51 +++++++++ docs/Aanbieden.md | 3 + docs/Toevoegen.md | 32 ++++++ docs/Zoeken.md | 12 --- 11 files changed, 290 insertions(+), 275 deletions(-) create mode 100644 Installation/Schema/Attachment.schema.json delete mode 100644 Installation/Schema/Bijlage.schema.json rename Installation/Schema/{Organisatie.schema.json => Organization.schema.json} (51%) delete mode 100644 Installation/Schema/Publicatie.schema.json create mode 100644 Installation/Schema/Publication.schema.json delete mode 100644 Installation/Schema/Thema.schema.json create mode 100644 Installation/Schema/Theme.schema.json create mode 100644 docs/Aanbieden.md create mode 100644 docs/Toevoegen.md delete mode 100644 docs/Zoeken.md diff --git a/Installation/Schema/Attachment.schema.json b/Installation/Schema/Attachment.schema.json new file mode 100644 index 0000000..25cabb9 --- /dev/null +++ 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 deleted file mode 100644 index 91d8748..0000000 --- a/Installation/Schema/Bijlage.schema.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "title": "Bijlage", - "$id": "https://openwoo.app/schemas/bijlage.schema.json", - "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json", - "version": "0.0.1", - "type": "object", - "description": "H", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description":"De unieke identifier van dit onderwerp" - }, - "titel": { - "type": "string", - "format": "text", - "description":"De titel (naam) van een onderwerp", - "minLength": 25, - "maxLength": 255, - "required": true - }, - "samenvatting": { - "type": "string", - "format": "text", - "description":"Een korte samenvatting van het onderwerp voor op de overzichts pagina", - "minLength": 50, - "maxLength": 2500, - "required": true - }, - "beschrijving": { - "type": "string", - "format": "text", - "description":"Een uitgebreide beschrijving van het onderwerp voor weergave op de onderwerp pagina", - "maxLength": 25000 - }, - "labels": { - "type": "array", - "description": "Eventueele labels op de bijlage doe worden gebruikt voor het beoordelen om wat voor een bestand het gaat" - }, - "url": { - "type": "string", - "format": "url", - "description": "De url naar het oorspronklenlijke document", - "required": true - }, - "documentText": { - "type": "string", - "format": "text", - "description": "De tekst uit het oorspronkenlijke document, deze wordt opgenomen in de zoek index om het doorzoeken van documenten te faciliteren" - }, - "type": { - "type": "string", - "format": "mime-type", - "description": "Het mime-type van de bijlage, wordt bepaald bij inlezen en opgenomen voor weergave in de ui" - }, - "extension": { - "type": "string", - "description": "De extensie van de bijlage, wordt bepaald bij inlezen en opgenomen voor weergave in de ui" - }, - "size": { - "type": "integer", - "description": "De grote van de bijlage in bytes, wordt bepaald bij inlezen en opgenomen voor weergave in de ui" - } - }, - "required": [ - "titel", - "samenvatting", - "url" - ] -} \ No newline at end of file diff --git a/Installation/Schema/Index.schema.json b/Installation/Schema/Index.schema.json index ef2f221..1144110 100644 --- 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" ] -} \ No newline at end of file +} diff --git a/Installation/Schema/Organisatie.schema.json b/Installation/Schema/Organization.schema.json similarity index 51% rename from Installation/Schema/Organisatie.schema.json rename to Installation/Schema/Organization.schema.json index 404b1d4..8a9fb64 100644 --- a/Installation/Schema/Organisatie.schema.json +++ b/Installation/Schema/Organization.schema.json @@ -1,43 +1,42 @@ { - "title": "Organisatie", - "$id": "https://openwoo.app/schemas/organisatie.schema.json", + "title": "Organization", + "$id": "https://openwoo.app/schemas/organization.schema.json", "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json", "version": "0.0.1", "type": "object", - "description": "Een organisatie die een publicatie of index ter beschicking steld", + "description": "An organization that provides a publication or index", "properties": { "id": { "type": "string", "format": "uuid", - "description":"De unieke identifier deze organisatie" + "description": "The unique identifier for this organization" }, - "titel": { + "title": { "type": "string", "format": "text", - "description":"De titel (naam) van een onderwerp", + "description": "The title (name) of a subject", "minLength": 25, "maxLength": 255, "required": true }, - "samenvatting": { + "summary": { "type": "string", "format": "text", - "description":"Een korte samenvatting van het onderwerp voor op de overzichts pagina", + "description": "A short summary of the subject for the overview page", "minLength": 50, "maxLength": 2500, "required": true }, - "beschrijving": { + "description": { "type": "string", "format": "text", - "description":"Een uitgebreide beschrijving van het onderwerp voor weergave op de onderwerp pagina", - "maxLength": 25000, - "required": true + "description": "An extensive description of the subject for display on the subject page", + "maxLength": 25000 }, - "afbeelding": { + "image": { "type": "string", - "format": ["url","base64"], - "description":"Een afbeelding voor bij het onderwerp, mag worden opgegeven als verwijzing `url` of `base64` encoded image" + "format": ["url", "base64"], + "description": "An image for the subject, can be provided as a reference `url` or `base64` encoded image" }, "uuid": { "type": "string" @@ -51,14 +50,13 @@ "rsin": { "type": "string" }, - "naam": { + "name": { "type": "string", "required": true } }, "required": [ - "titel", - "samenvatting", - "beschrijving" + "title", + "summary" ] -} \ No newline at end of file +} diff --git a/Installation/Schema/Publicatie.schema.json b/Installation/Schema/Publicatie.schema.json deleted file mode 100644 index db1a67e..0000000 --- a/Installation/Schema/Publicatie.schema.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "title": "Publicatie", - "$id": "https://openwoo.app/schemas/publicatie.schema.json", - "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json", - "version": "0.0.1", - "type": "object", - "description": "Het publicatie object vormt de kern van Open Index, het fungeert als een metadata wrapper voor objecten en vormt daarmee het gemeen schappenlijk verband tussen de verschillende publcaties uit bijvoorbeeld de WOO en OC.", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description":"De unieke identifier van deze publicatie" - }, - "titel": { - "type": "string", - "format": "text", - "description":"De titel (naam) van een publicatie", - "minLength": 25, - "maxLength": 255, - "required": true - }, - "samenvatting": { - "type": "string", - "format": "text", - "description":"Een korte samenvatting van de publicatie voor op de overzichts pagina", - "minLength": 50, - "maxLength": 255, - "required": true - }, - "beschrijving": { - "type": "string", - "format": "text", - "description":"Een uitgebreide beschrijving van de publicatie voor weergave op de publicatie pagina", - "maxLength": 2555, - "required": true - }, - "afbeelding": { - "type": "string", - "format": ["url","base64"], - "description":"Een afbeelding voor bij de publicatie, mag worden opgegeven als verwijzing `url` of `base64` encoded image" - }, - "categorie": { - "type": "string", - "description":"De categorie waarbinnen de publicatie valt, dit kunnen zelf gedefineerde categorien zijn of vooraf gedefineerd categorien", - "minLength": 25, - "maxLength": 255, - "required": true - }, - "portal": { - "type": "string", - "format": "url", - "description":"Een optionele verwijzing naar een afwijkende publicatie pagina, bijvoorbeeld in het RIS" - }, - "publicatiedatum": { - "description": "Datum vanaf wanneer deze publicatie vindbaar moet zijn, dit mag een datum in de toekomst of verleden zijn. Publicaties waarbij deze datum in de toekomst ligt of leeg is worden NIET weergegeven", - "type": "string", - "format": "date-time", - "default": "now" - }, - "featured": { - "description": "Datum vanaf wanneer deze publicatie vindbaar moet zijn, dit mag een datum in de toekomst of verleden zijn. Publicaties waarbij deze datum in de toekomst ligt of leeg is worden NIET weergegeven", - "type": "boolean", - "default": false - }, - "organisatie": { - "type": "object", - "$ref": "https://commongateway.nl/woo.organisatie.schema.json", - "format": "json", - "description": "De organisatie horende bij dit publicatie object, in theorie kunnen meerdere organisaties één Open Index installatie delen maar we ontraden dit." - }, - "schema": { - "type": "string", - "format": "url", - "description":"Een publiek toegankenlijke verwijzing naar het object type (in schema.json) van de gepubliceerde data. Deze word zowel gebruikt om de aangeleverde data te valideren als eventueele afnemers te voorzien van context over de gevonden data", - "required": true - }, - "bijlagen": { - "type": "array", - "items": { - "$ref": "https://commongateway.nl/woo.bijlage.schema.json" - }, - "format": "json" - }, - "onderwerp": { - "type": "object", - "$ref": "https://docs.openwoo.app/schemas/onderwerp.schema.json", - "format": "json" - }, - "data": { - "type": "object", - "format": "json", - "description":"Het daad werkenlijk te publiceren object (mag niet groter zijn dan 15 mb)" - } - }, - "required": [ - "titel", - "samenvatting", - "beschrijving", - "categorie", - "metadata" - ] -} \ No newline at end of file diff --git a/Installation/Schema/Publication.schema.json b/Installation/Schema/Publication.schema.json new file mode 100644 index 0000000..40f6b17 --- /dev/null +++ b/Installation/Schema/Publication.schema.json @@ -0,0 +1,100 @@ +{ + "title": "Publication", + "$id": "https://openwoo.app/schemas/publication.schema.json", + "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json", + "version": "0.0.1", + "type": "object", + "description": "The publication object is the core of Open Index, acting as a metadata wrapper for objects and thereby forming the common link between different publications from, for example, WOO and OC.", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The unique identifier of this publication" + }, + "title": { + "type": "string", + "format": "text", + "description": "The title (name) of a publication", + "minLength": 25, + "maxLength": 255, + "required": true + }, + "summary": { + "type": "string", + "format": "text", + "description": "A short summary of the publication for the overview page", + "minLength": 50, + "maxLength": 255, + "required": true + }, + "description": { + "type": "string", + "format": "text", + "description": "An extensive description of the publication for display on the publication page", + "maxLength": 2555 + }, + "image": { + "type": "string", + "format": ["url", "base64"], + "description": "An image for the publication, can be provided as a reference `url` or `base64` encoded image" + }, + "category": { + "type": "string", + "description": "The category within which the publication falls, these can be self-defined categories or predefined categories", + "minLength": 25, + "maxLength": 255, + "required": true + }, + "portal": { + "type": "string", + "format": "url", + "description": "An optional reference to a different publication page, for example in the RIS" + }, + "publicationDate": { + "description": "Date from when this publication should be discoverable, this can be a date in the future or past. Publications where this date is in the future or is blank will **NOT** be displayed in queries of the search API **UNLESS** the call is authenticated.", + "type": "string", + "format": "date-time", + "default": "now" + }, + "featured": { + "description": "`Featured` can be used to indicate that a publication should be discoverable on, for example, the homepage of a publication platform. From the API perspective, this property merely acts as a flag to find the items that are featured faster. The actual functionality of feature can thus vary per publication platform.", + "type": "boolean", + "default": false + }, + "organization": { + "type": "object", + "$ref": "https://openwoo.app/schemas/organization.schema.json", + "format": "json", + "description": "The organization belonging to this publication object, in theory multiple organizations can share one Open Index installation but this is discouraged." + }, + "schema": { + "type": "string", + "format": "url", + "description": "Schemas add predictability and interpretability to the objects published under `data`. They describe the object contained in `data` and the conditions it must meet. For this, we use the [json-schema](https://json-schema.org/) which is itself part of [OAS 3](https://swagger.io/specification/). In the `schema` property, we expect a URL reference to a publicly accessible schema.json object. This could be on a website or GitHub, for instance. During `POST` and `PUT` actions on the publication object, the object in `data` is tested against this schema. Additionally, a consuming party can use the URL to retrieve the schema so they can interpret the object in `data`.", + "required": true + }, + "attachments": { + "type": "array", + "items": { + "$ref": "https://openwoo.app/schemas/attachment.schema.json" + }, + "format": "json" + }, + "themes": { + "type": "array", + "format": "url", + "description":"The urls of the theme's associated with this publication" + }, + "data": { + "type": "object", + "format": "json", + "description": "The actual object to be published (must not be larger than 15 MB)" + } + }, + "required": [ + "title", + "summary", + "category", + "schema" + ] +} diff --git a/Installation/Schema/Thema.schema.json b/Installation/Schema/Thema.schema.json deleted file mode 100644 index 8c3956b..0000000 --- a/Installation/Schema/Thema.schema.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "title": "Thema", - "$id": "https://openwoo.app/schemas/thema.schema.json", - "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json", - "version": "0.0.1", - "type": "object", - "description": "Een thematische clustering van publicaties in voor de zoeken logische manier, kan bijvoorbeeld ook worden gebruikt voor onderwerpen", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description":"De unieke identifier van dit thema" - }, - "titel": { - "type": "string", - "format": "text", - "description":"De titel (naam) van een thema", - "minLength": 25, - "maxLength": 255, - "required": true - }, - "samenvatting": { - "type": "string", - "format": "text", - "description":"Een korte samenvatting van het thema voor op de overzichts pagina", - "minLength": 50, - "maxLength": 2500, - "required": true - }, - "beschrijving": { - "type": "string", - "format": "text", - "description":"Een uitgebreide beschrijving van het thema voor weergave op de thema pagina", - "maxLength": 25000, - "required": true - }, - "afbeelding": { - "type": "string", - "format": ["url","base64"], - "description":"Een afbeelding voor bij het thema, mag worden opgegeven als verwijzing `url` of `base64` encoded image" - }, - "publicaties": { - "type": "integer", - "description":"Het aantal publicaties dat bij dit thema hoort" - } - }, - "required": [ - "titel", - "samenvatting" - ] -} \ No newline at end of file diff --git a/Installation/Schema/Theme.schema.json b/Installation/Schema/Theme.schema.json new file mode 100644 index 0000000..10adea8 --- /dev/null +++ b/Installation/Schema/Theme.schema.json @@ -0,0 +1,51 @@ +{ + "title": "Theme", + "$id": "https://openwoo.app/schemas/theme.schema.json", + "$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json", + "version": "0.0.1", + "type": "object", + "description": "A thematic clustering of publications in a manner logical for searching, can also be used for topics. Themes exist within a single index and are thus organization specific unless the index is shared by multiple organizations", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description":"The unique identifier of this theme" + }, + "title": { + "type": "string", + "format": "text", + "description":"The title (name) of a theme.", + "minLength": 25, + "maxLength": 255, + "required": true, + "unique":true + }, + "summary": { + "type": "string", + "format": "text", + "description":"A short summary of the theme for the overview page", + "minLength": 50, + "maxLength": 2500, + "required": true + }, + "description": { + "type": "string", + "format": "text", + "description":"An extensive description of the theme for display on the theme page", + "maxLength": 25000 + }, + "image": { + "type": "string", + "format": ["url","base64"], + "description":"An image for the theme, can be provided as a reference `url` or `base64` encoded image" + }, + "publications": { + "type": "integer", + "description":"The number of publications associated with this theme, this value is automatically updated and thus cannot be set via the API" + } + }, + "required": [ + "title", + "summary" + ] +} diff --git a/docs/Aanbieden.md b/docs/Aanbieden.md new file mode 100644 index 0000000..08f3c54 --- /dev/null +++ b/docs/Aanbieden.md @@ -0,0 +1,3 @@ +# Toevoegen + +Publicatie kunnen aan een Open Index worden toegevoegd door het aan maken van een publicatie object. \ No newline at end of file diff --git a/docs/Toevoegen.md b/docs/Toevoegen.md new file mode 100644 index 0000000..783f2b9 --- /dev/null +++ b/docs/Toevoegen.md @@ -0,0 +1,32 @@ +# Toevoegen + +Publicaties kunnen aan een Open Index installatie worden toegevoegd door het aanmaken van een publicatie object, dit kan direct via de API of door gebruik te maken van een onderliggende service die de informatie in synchroniseert vanuit bronnen (zo als de open woo service of open catalogi service). + +Een publicatie object fungeert als een envelop voor het daadwerkelijk te publiceren object. Het object dat je wilt publiceren zal dus gedefinieerd moeten zijn, dat doen we in de vorm van een schema json bestand dat online benaderbaar moet staan, bijvoorbeeld Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.schema.json + +Daarnaast moet het publicatie object minimaal beschikken over een naam en samenvatting. Eventueele bijlagen kunnen worden aangemaakt aan de hand van hun url. + +Laten we er eens vanuit gaan dat we een advies willen publiceren, met twee bijlage. + +```json +{ + "attachments": [ + { "url":"asdasd"}, + { "url":"asdasd"} + ] +} + +``` + +Reponce + + +```json +{ + "attachments": [ + { "url":"asdasd"}, + { "url":"asdasd"} + ] +} + +``` \ No newline at end of file diff --git a/docs/Zoeken.md b/docs/Zoeken.md deleted file mode 100644 index 8365891..0000000 --- a/docs/Zoeken.md +++ /dev/null @@ -1,12 +0,0 @@ -# Zoeken - -## Inleiding - - -## Facetten -Facetten zijn specifieke kenmerken of categorieën die gebruikt worden om informatie in een database of zoekmachine te organiseren en te filteren. Deze kenmerken kunnen variëren van datums en locaties tot merken of thema's, afhankelijk van de aard van de gegevens. Gefacetteerd zoeken is belangrijk omdat het gebruikers in staat stelt om een grote hoeveelheid informatie efficiënt te doorzoeken en snel te verfijnen tot de meest relevante resultaten. Dit verbetert de gebruikerservaring aanzienlijk doordat het zoekproces vereenvoudigd wordt en gebruikers actief kunnen deelnemen aan het filteren van de zoekresultaten op basis van hun specifieke behoeften of interesses. Zo wordt de overvloed aan beschikbare informatie hanteerbaar en toegankelijk, wat essentieel is in omgevingen waar snel toegang nodig is tot specifieke gegevens, zoals online winkels, digitale bibliotheken, of informatieve databases. - -Gefacetteerd zoeken kan ook uiterst waardevol zijn voor het weergeven van statistische informatie en het samenstellen van dashboards. Door het gebruik van facetten kunnen gebruikers dynamisch verschillende datasets filteren en vergelijken binnen een dashboardomgeving. Dit stelt hen in staat om complexe data sets te analyseren en trends te ontdekken die anders verborgen zouden blijven. Bijvoorbeeld, in een zakelijke context kunnen managers en analisten facetten gebruiken om verkoopcijfers te segmenteren op basis van productcategorieën, geografische locaties, of tijdperioden. Dit resulteert in een flexibele en interactieve ervaring waarbij gebruikers specifieke aspecten van de data kunnen verkennen en visualiseren, waardoor ze beter onderbouwde beslissingen kunnen nemen. Dit maakt gefacetteerd zoeken een krachtige tool voor zowel real-time monitoring als diepgaande analyse binnen organisaties. - - - From 10b9e35be9238279ae29d4640d8d9a64cda2ff47 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 7 May 2024 20:28:12 +0000 Subject: [PATCH 5/6] Render PlantUML files --- docs/schema/Bijlage.svg | 1 + docs/schema/Metadata.oc_publiccode.svg | 1 + docs/schema/Metadata.ods_agenda_item.svg | 1 + ...tadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg | 1 + docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg | 1 + docs/schema/Metadata.tooi_beschikkingen.svg | 1 + ...a.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg | 1 + docs/schema/Metadata.tooi_convenanten.svg | 1 + docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg | 1 + docs/schema/Metadata.tooi_klachtoordelen.svg | 1 + ...tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg | 1 + .../Metadata.tooi_overige_besluiten_van_algemene_strekking.svg | 1 + docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg | 1 + docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg | 1 + ...tadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg | 1 + docs/schema/Publicatie.svg | 1 + docs/schema/all_schema_classes.svg | 2 +- 17 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/schema/Bijlage.svg create mode 100644 docs/schema/Metadata.oc_publiccode.svg create mode 100644 docs/schema/Metadata.ods_agenda_item.svg create mode 100644 docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg create mode 100644 docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg create mode 100644 docs/schema/Metadata.tooi_beschikkingen.svg create mode 100644 docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg create mode 100644 docs/schema/Metadata.tooi_convenanten.svg create mode 100644 docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg create mode 100644 docs/schema/Metadata.tooi_klachtoordelen.svg create mode 100644 docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg create mode 100644 docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.svg create mode 100644 docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg create mode 100644 docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg create mode 100644 docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg create mode 100644 docs/schema/Publicatie.svg diff --git a/docs/schema/Bijlage.svg b/docs/schema/Bijlage.svg new file mode 100644 index 0000000..f528458 --- /dev/null +++ b/docs/schema/Bijlage.svg @@ -0,0 +1 @@ +SchemaBijlageBijlageid: stringtitel: stringsamenvatting: stringbeschrijving: stringlabels: arrayurl: stringdocumentText: stringtype: stringextension: stringsize: integerCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.oc_publiccode.svg b/docs/schema/Metadata.oc_publiccode.svg new file mode 100644 index 0000000..cb8c192 --- /dev/null +++ b/docs/schema/Metadata.oc_publiccode.svg @@ -0,0 +1 @@ +SchemaMetadataOpenCatalogiPubliccodeMetadataOpenCatalogiPubliccodetooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringoprdachtgever: stringonderdeelTaak: stringonderwerp: stringfeitelijkMateriaal: booleanvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.ods_agenda_item.svg b/docs/schema/Metadata.ods_agenda_item.svg new file mode 100644 index 0000000..cb8c192 --- /dev/null +++ b/docs/schema/Metadata.ods_agenda_item.svg @@ -0,0 +1 @@ +SchemaMetadataOpenCatalogiPubliccodeMetadataOpenCatalogiPubliccodetooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringoprdachtgever: stringonderdeelTaak: stringonderwerp: stringfeitelijkMateriaal: booleanvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg b/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg new file mode 100644 index 0000000..c9c210c --- /dev/null +++ b/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIagenda’senbesluitenlijstenbestuurscollegesMetadataTOOIagenda’senbesluitenlijstenbestuurscollegestooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg b/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg new file mode 100644 index 0000000..3385690 --- /dev/null +++ b/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIbereikbaarheidsgegevensMetadataTOOIbereikbaarheidsgegevenstooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_beschikkingen.svg b/docs/schema/Metadata.tooi_beschikkingen.svg new file mode 100644 index 0000000..827e45c --- /dev/null +++ b/docs/schema/Metadata.tooi_beschikkingen.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIbeschikkingenMetadataTOOIbeschikkingentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg b/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg new file mode 100644 index 0000000..f4896d6 --- /dev/null +++ b/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIbijvertegenwoordigendeorganeningekomenstukkenMetadataTOOIbijvertegenwoordigendeorganeningekomenstukkentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_convenanten.svg b/docs/schema/Metadata.tooi_convenanten.svg new file mode 100644 index 0000000..843fd99 --- /dev/null +++ b/docs/schema/Metadata.tooi_convenanten.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIconvenantenMetadataTOOIconvenantentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg b/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg new file mode 100644 index 0000000..7a6aae8 --- /dev/null +++ b/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIjaarplannenenjaarverslagenMetadataTOOIjaarplannenenjaarverslagentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_klachtoordelen.svg b/docs/schema/Metadata.tooi_klachtoordelen.svg new file mode 100644 index 0000000..d16ea2c --- /dev/null +++ b/docs/schema/Metadata.tooi_klachtoordelen.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIklachtoordelenMetadataTOOIklachtoordelentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringdatumBesluit: stringdatumOntvangst: stringtermijnoverschrijding: stringorganisatieonderdeel: stringfunctiebenaming: stringgedraging: stringbevindingen: stringoordeel: stringconclusies: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg b/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg new file mode 100644 index 0000000..d37aae0 --- /dev/null +++ b/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraagMetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraagtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.svg b/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.svg new file mode 100644 index 0000000..6b87fbc --- /dev/null +++ b/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIoverigebesluitenvanalgemenestrekkingMetadataTOOIoverigebesluitenvanalgemenestrekkingtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg b/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg new file mode 100644 index 0000000..6ef9117 --- /dev/null +++ b/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIvergaderstukkenStaten-GeneraalMetadataTOOIvergaderstukkenStaten-GeneraaltooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg b/docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg new file mode 100644 index 0000000..2a47f78 --- /dev/null +++ b/docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIWoo-verzoekenen-besluitenMetadataTOOIWoo-verzoekenen-besluitentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringdatumBesluit: stringdatumOntvangst: stringtermijnoverschrijding: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg b/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg new file mode 100644 index 0000000..10be8d2 --- /dev/null +++ b/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg @@ -0,0 +1 @@ +SchemaMetadataTOOIwettenenalgemeenverbindendevoorschriftenMetadataTOOIwettenenalgemeenverbindendevoorschriftentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/Publicatie.svg b/docs/schema/Publicatie.svg new file mode 100644 index 0000000..89529cd --- /dev/null +++ b/docs/schema/Publicatie.svg @@ -0,0 +1 @@ +SchemaPublicatiePublicatieid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringcategorie: stringportal: stringpublicatiedatum: stringfeatured: booleanorganisatie: objectschema: stringbijlagen: arrayonderwerp: objectdata: objectCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file diff --git a/docs/schema/all_schema_classes.svg b/docs/schema/all_schema_classes.svg index c80fab1..330c05b 100644 --- a/docs/schema/all_schema_classes.svg +++ b/docs/schema/all_schema_classes.svg @@ -1 +1 @@ -SchemaAll schemasMetadataTOOIjaarplannenenjaarverslagentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIagenda’senbesluitenlijstenbestuurscollegestooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIadviezentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringoprdachtgever: stringonderdeelTaak: stringonderwerp: stringfeitelijkMateriaal: booleanvalues: arrayIndexid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringurl: stringstatus: integerorganisatie: objectBijlageid: stringtitel: stringsamenvatting: stringbeschrijving: stringlabels: arrayurl: stringdocumentText: stringtype: stringextension: stringsize: integerMetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraagtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayPublicatieid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringcategorie: stringportal: stringpublicatiedatum: stringfeatured: booleanorganisatie: objectschema: stringbijlagen: arrayonderwerp: objectdata: objectMetadataTOOIconvenantentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIvergaderstukkenStaten-GeneraaltooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIvergaderstukkendecentraleoverhedentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayThemaid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringpublicaties: integerMetadataTOOIorganisatieenwerkwijzetooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIsubsidieverplichtingenandersdanmetbeschikkingtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIWoo-verzoekenen-besluitentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringdatumBesluit: stringdatumOntvangst: stringtermijnoverschrijding: stringvalues: arrayMetadataTOOIbereikbaarheidsgegevenstooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayOrganisatieid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringuuid: stringoin: stringtooi: stringrsin: stringnaam: stringMetadataTOOIoverigebesluitenvanalgemenestrekkingtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIbijvertegenwoordigendeorganeningekomenstukkentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIwettenenalgemeenverbindendevoorschriftentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIonderzoeksrapportentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIklachtoordelentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringdatumBesluit: stringdatumOntvangst: stringtermijnoverschrijding: stringorganisatieonderdeel: stringfunctiebenaming: stringgedraging: stringbevindingen: stringoordeel: stringconclusies: stringvalues: arrayMetadataTOOIbeschikkingentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file +SchemaAll schemasMetadataTOOIwettenenalgemeenverbindendevoorschriftentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataOpenCatalogiPubliccodetooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringoprdachtgever: stringonderdeelTaak: stringonderwerp: stringfeitelijkMateriaal: booleanvalues: arraytooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringoprdachtgever: stringonderdeelTaak: stringonderwerp: stringfeitelijkMateriaal: booleanvalues: arrayPublicatieid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringcategorie: stringportal: stringpublicatiedatum: stringfeatured: booleanorganisatie: objectschema: stringbijlagen: arrayonderwerp: objectdata: objectMetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraagtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIvergaderstukkendecentraleoverhedentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIbijvertegenwoordigendeorganeningekomenstukkentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayThemaid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringpublicaties: integerMetadataTOOIoverigebesluitenvanalgemenestrekkingtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIonderzoeksrapportentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIconvenantentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayIndexid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringurl: stringstatus: integerorganisatie: objectMetadataTOOIklachtoordelentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringdatumBesluit: stringdatumOntvangst: stringtermijnoverschrijding: stringorganisatieonderdeel: stringfunctiebenaming: stringgedraging: stringbevindingen: stringoordeel: stringconclusies: stringvalues: arrayMetadataTOOIvergaderstukkenStaten-GeneraaltooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayOrganisatieid: stringtitel: stringsamenvatting: stringbeschrijving: stringafbeelding: stringuuid: stringoin: stringtooi: stringrsin: stringnaam: stringBijlageid: stringtitel: stringsamenvatting: stringbeschrijving: stringlabels: arrayurl: stringdocumentText: stringtype: stringextension: stringsize: integerMetadataTOOIagenda’senbesluitenlijstenbestuurscollegestooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIbereikbaarheidsgegevenstooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIbeschikkingentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIjaarplannenenjaarverslagentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIWoo-verzoekenen-besluitentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringdatumBesluit: stringdatumOntvangst: stringtermijnoverschrijding: stringvalues: arrayMetadataTOOIorganisatieenwerkwijzetooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayMetadataTOOIadviezentooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringoprdachtgever: stringonderdeelTaak: stringonderwerp: stringfeitelijkMateriaal: booleanvalues: arrayMetadataTOOIsubsidieverplichtingenandersdanmetbeschikkingtooiCategorieNaam: stringtooiCategorieId: stringtooiCategorieUri: stringtooiThemaNaam: stringtooiThemaId: stringtooiThemaUri: stringvalues: arrayCommon Gateway Plugin | Commongateway | Openindex \ No newline at end of file From b202840d1b522cdd5bade9918ffb041b143f010d Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 7 May 2024 20:28:23 +0000 Subject: [PATCH 6/6] Add generated puml,svg,md and README files based on plugin installation files --- docs/schema/Attachment.md | 20 ++++++ docs/schema/Attachment.puml | 18 +++++ docs/schema/Index.md | 18 ++--- docs/schema/Index.puml | 10 +-- docs/schema/Organization.md | 20 ++++++ docs/schema/Organization.puml | 18 +++++ docs/schema/Publication.md | 24 +++++++ docs/schema/Publication.puml | 22 ++++++ docs/schema/README.md | 8 +-- docs/schema/Theme.md | 16 +++++ docs/schema/Theme.puml | 14 ++++ docs/schema/all_schema_classes.puml | 102 ++++++++++++++-------------- 12 files changed, 221 insertions(+), 69 deletions(-) create mode 100644 docs/schema/Attachment.md create mode 100644 docs/schema/Attachment.puml create mode 100644 docs/schema/Organization.md create mode 100644 docs/schema/Organization.puml create mode 100644 docs/schema/Publication.md create mode 100644 docs/schema/Publication.puml create mode 100644 docs/schema/Theme.md create mode 100644 docs/schema/Theme.puml diff --git a/docs/schema/Attachment.md b/docs/schema/Attachment.md new file mode 100644 index 0000000..bd98f40 --- /dev/null +++ b/docs/schema/Attachment.md @@ -0,0 +1,20 @@ +# Attachment + +An attachment object + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Attachment.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| id | string | The unique identifier of this subject | No | +| title | string | The title (name) of a Attachment, if the title is left empty the file name wil be used instead | No | +| summary | string | A short summary of the subject for the overview page | No | +| description | string | An extensive description of the subject for display on the subject page | No | +| labels | array | Possible labels on the attachment that are used to assess what kind of file it is | No | +| url | string | 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 | Yes | +| documentText | string | 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 | No | +| type | string | 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 | No | +| extension | string | 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 | No | +| size | integer | 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 | No | diff --git a/docs/schema/Attachment.puml b/docs/schema/Attachment.puml new file mode 100644 index 0000000..5ce6e18 --- /dev/null +++ b/docs/schema/Attachment.puml @@ -0,0 +1,18 @@ +@startuml +title: Attachment +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class Attachment { + + id: string + + title: string + + summary: string + + description: string + + labels: array + + url: string + + documentText: string + + type: string + + extension: string + + size: integer +} +@enduml diff --git a/docs/schema/Index.md b/docs/schema/Index.md index 20a4061..b31e36f 100644 --- a/docs/schema/Index.md +++ b/docs/schema/Index.md @@ -1,6 +1,6 @@ # Index -Een extern gevonden index die als bron kan worden gebruikt bij het stellen van federatieve zoekvragen +An externally found index that can be used as a source in federative search queries ![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Index.svg) @@ -8,11 +8,11 @@ Een extern gevonden index die als bron kan worden gebruikt bij het stellen van f | Property | Type | Description | Required | |----------|------|-------------|----------| -| id | string | De unieke identifier van de index | No | -| titel | string | De titel (naam) van de index | Yes | -| samenvatting | string | Een korte samenvatting van de index | Yes | -| beschrijving | string | Een uitgebreide beschrijving van de index voor weergave op de index pagina | Yes | -| afbeelding | string | Een afbeelding voor bij de index, bijvoorbeeld een logo. Mag worden opgegeven als verwijzing `url` of `base64` encoded image | No | -| url | string | De url naar de API van de index | No | -| status | integer | De meest recente status van deze index | No | -| organisatie | object | De organisatie die deze index beschickbaar stelt (fungeerd als default voor publicaties in de index) | No | +| id | string | The unique identifier of the index | No | +| title | string | The title (name) of the index | Yes | +| summary | string | A short summary of the index | Yes | +| description | string | An extensive description of the index for display on the index page | Yes | +| image | string | An image for the index, such as a logo. Can be provided as a reference `url` or `base64` encoded image | No | +| url | string | The URL to the index's API | No | +| status | integer | The most recent status of this index | No | +| organization | object | The organization that provides this index (acts as the default for publications in the index) | No | diff --git a/docs/schema/Index.puml b/docs/schema/Index.puml index 35fecd1..e966a17 100644 --- a/docs/schema/Index.puml +++ b/docs/schema/Index.puml @@ -5,12 +5,12 @@ header: Schema class Index { + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string + + title: string + + summary: string + + description: string + + image: string + url: string + status: integer - + organisatie: object + + organization: object } @enduml diff --git a/docs/schema/Organization.md b/docs/schema/Organization.md new file mode 100644 index 0000000..bd5d569 --- /dev/null +++ b/docs/schema/Organization.md @@ -0,0 +1,20 @@ +# Organization + +An organization that provides a publication or index + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Organization.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| id | string | The unique identifier for this organization | No | +| title | string | The title (name) of a subject | Yes | +| summary | string | A short summary of the subject for the overview page | Yes | +| description | string | An extensive description of the subject for display on the subject page | No | +| image | string | An image for the subject, can be provided as a reference `url` or `base64` encoded image | No | +| uuid | string | N/A | No | +| oin | string | N/A | No | +| tooi | string | N/A | No | +| rsin | string | N/A | No | +| name | string | N/A | No | diff --git a/docs/schema/Organization.puml b/docs/schema/Organization.puml new file mode 100644 index 0000000..58a1a5a --- /dev/null +++ b/docs/schema/Organization.puml @@ -0,0 +1,18 @@ +@startuml +title: Organization +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class Organization { + + id: string + + title: string + + summary: string + + description: string + + image: string + + uuid: string + + oin: string + + tooi: string + + rsin: string + + name: string +} +@enduml diff --git a/docs/schema/Publication.md b/docs/schema/Publication.md new file mode 100644 index 0000000..306c232 --- /dev/null +++ b/docs/schema/Publication.md @@ -0,0 +1,24 @@ +# Publication + +The publication object is the core of Open Index, acting as a metadata wrapper for objects and thereby forming the common link between different publications from, for example, WOO and OC. + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Publication.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| id | string | The unique identifier of this publication | No | +| title | string | The title (name) of a publication | Yes | +| summary | string | A short summary of the publication for the overview page | Yes | +| description | string | An extensive description of the publication for display on the publication page | No | +| image | string | An image for the publication, can be provided as a reference `url` or `base64` encoded image | No | +| category | string | The category within which the publication falls, these can be self-defined categories or predefined categories | Yes | +| portal | string | An optional reference to a different publication page, for example in the RIS | No | +| publicationDate | string | Date from when this publication should be discoverable, this can be a date in the future or past. Publications where this date is in the future or is blank will **NOT** be displayed in queries of the search API **UNLESS** the call is authenticated. | No | +| featured | boolean | `Featured` can be used to indicate that a publication should be discoverable on, for example, the homepage of a publication platform. From the API perspective, this property merely acts as a flag to find the items that are featured faster. The actual functionality of feature can thus vary per publication platform. | No | +| organization | object | The organization belonging to this publication object, in theory multiple organizations can share one Open Index installation but this is discouraged. | No | +| schema | string | Schemas add predictability and interpretability to the objects published under `data`. They describe the object contained in `data` and the conditions it must meet. For this, we use the [json-schema](https://json-schema.org/) which is itself part of [OAS 3](https://swagger.io/specification/). In the `schema` property, we expect a URL reference to a publicly accessible schema.json object. This could be on a website or GitHub, for instance. During `POST` and `PUT` actions on the publication object, the object in `data` is tested against this schema. Additionally, a consuming party can use the URL to retrieve the schema so they can interpret the object in `data`. | Yes | +| attachments | array | N/A | No | +| themes | array | The urls of the theme's associated with this publication | No | +| data | object | The actual object to be published (must not be larger than 15 MB) | No | diff --git a/docs/schema/Publication.puml b/docs/schema/Publication.puml new file mode 100644 index 0000000..bf6d514 --- /dev/null +++ b/docs/schema/Publication.puml @@ -0,0 +1,22 @@ +@startuml +title: Publication +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class Publication { + + id: string + + title: string + + summary: string + + description: string + + image: string + + category: string + + portal: string + + publicationDate: string + + featured: boolean + + organization: object + + schema: string + + attachments: array + + themes: array + + data: object +} +@enduml diff --git a/docs/schema/README.md b/docs/schema/README.md index 9a4064e..960920e 100644 --- a/docs/schema/README.md +++ b/docs/schema/README.md @@ -5,12 +5,12 @@ | Class | Documentation | |-------|--------------| | Metadata TOOI wetten en algemeen verbindende voorschriften | [Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md](Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.md) | +| Publication | [Publication.md](Publication.md) | | Metadata Open Catalogi Publiccode | [Metadata.ods_agenda_item.md](Metadata.ods_agenda_item.md) | -| Publicatie | [Publicatie.md](Publicatie.md) | | Metadata TOOI ontwerpen van wet- en regelgeving met adviesaanvraag | [Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md](Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.md) | | Metadata TOOI vergaderstukken decentrale overheden | [Metadata.tooi_vergaderstukken_decentrale_overheden.md](Metadata.tooi_vergaderstukken_decentrale_overheden.md) | | Metadata TOOI bij vertegenwoordigende organen ingekomen stukken | [Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md](Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.md) | -| Thema | [Thema.md](Thema.md) | +| Attachment | [Attachment.md](Attachment.md) | | Metadata Open Catalogi Publiccode | [Metadata.oc_publiccode.md](Metadata.oc_publiccode.md) | | Metadata TOOI overige besluiten van algemene strekking | [Metadata.tooi_overige_besluiten_van_algemene_strekking.md](Metadata.tooi_overige_besluiten_van_algemene_strekking.md) | | Metadata TOOI onderzoeksrapporten | [Metadata.tooi_onderzoeksrapporten.md](Metadata.tooi_onderzoeksrapporten.md) | @@ -18,13 +18,13 @@ | Index | [Index.md](Index.md) | | Metadata TOOI klachtoordelen | [Metadata.tooi_klachtoordelen.md](Metadata.tooi_klachtoordelen.md) | | Metadata TOOI vergaderstukken Staten-Generaal | [Metadata.tooi_vergaderstukken_staten_generaal.md](Metadata.tooi_vergaderstukken_staten_generaal.md) | -| Organisatie | [Organisatie.md](Organisatie.md) | -| Bijlage | [Bijlage.md](Bijlage.md) | | Metadata TOOI agenda’s en besluitenlijsten bestuurscolleges | [Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.md](Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.md) | | Metadata TOOI bereikbaarheidsgegevens | [Metadata.tooi_bereikbaarheidsgegevens.md](Metadata.tooi_bereikbaarheidsgegevens.md) | | Metadata TOOI beschikkingen | [Metadata.tooi_beschikkingen.md](Metadata.tooi_beschikkingen.md) | | Metadata TOOI jaarplannen en jaarverslagen | [Metadata.tooi_jaarplannen_en_jaarverslagen.md](Metadata.tooi_jaarplannen_en_jaarverslagen.md) | | Metadata TOOI Woo-verzoeken en -besluiten | [Metadata.tooi_verzoeken_en_besluiten.md](Metadata.tooi_verzoeken_en_besluiten.md) | | Metadata TOOI organisatie en werkwijze | [Metadata.tooi_organisatie_en_werkwijze.md](Metadata.tooi_organisatie_en_werkwijze.md) | +| Theme | [Theme.md](Theme.md) | +| Organization | [Organization.md](Organization.md) | | Metadata TOOI adviezen | [Metadata.tooi_adviezen.md](Metadata.tooi_adviezen.md) | | Metadata TOOI subsidieverplichtingen anders dan met beschikking | [Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md](Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.md) | diff --git a/docs/schema/Theme.md b/docs/schema/Theme.md new file mode 100644 index 0000000..f5fd149 --- /dev/null +++ b/docs/schema/Theme.md @@ -0,0 +1,16 @@ +# Theme + +A thematic clustering of publications in a manner logical for searching, can also be used for topics. Themes exist within a single index and are thus organization specific unless the index is shared by multiple organizations + +![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/documentation-2024/docs/schema/Theme.svg) + +## Properties + +| Property | Type | Description | Required | +|----------|------|-------------|----------| +| id | string | The unique identifier of this theme | No | +| title | string | The title (name) of a theme. | Yes | +| summary | string | A short summary of the theme for the overview page | Yes | +| description | string | An extensive description of the theme for display on the theme page | No | +| image | string | An image for the theme, can be provided as a reference `url` or `base64` encoded image | No | +| publications | integer | The number of publications associated with this theme, this value is automatically updated and thus cannot be set via the API | No | diff --git a/docs/schema/Theme.puml b/docs/schema/Theme.puml new file mode 100644 index 0000000..333176e --- /dev/null +++ b/docs/schema/Theme.puml @@ -0,0 +1,14 @@ +@startuml +title: Theme +footer: Common Gateway Plugin | Commongateway | Openindex +header: Schema + +class Theme { + + id: string + + title: string + + summary: string + + description: string + + image: string + + publications: integer +} +@enduml diff --git a/docs/schema/all_schema_classes.puml b/docs/schema/all_schema_classes.puml index 39aa8f0..b613846 100644 --- a/docs/schema/all_schema_classes.puml +++ b/docs/schema/all_schema_classes.puml @@ -11,6 +11,22 @@ class MetadataTOOIwettenenalgemeenverbindendevoorschriften { + tooiThemaUri: string + values: array } +class Publication { + + id: string + + title: string + + summary: string + + description: string + + image: string + + category: string + + portal: string + + publicationDate: string + + featured: boolean + + organization: object + + schema: string + + attachments: array + + themes: array + + data: object +} class MetadataOpenCatalogiPubliccode { + tooiCategorieNaam: string + tooiCategorieId: string @@ -24,22 +40,6 @@ class MetadataOpenCatalogiPubliccode { + feitelijkMateriaal: boolean + values: array } -class Publicatie { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + categorie: string - + portal: string - + publicatiedatum: string - + featured: boolean - + organisatie: object - + schema: string - + bijlagen: array - + onderwerp: object - + data: object -} class MetadataTOOIontwerpenvanwet-enregelgevingmetadviesaanvraag { + tooiCategorieNaam: string + tooiCategorieId: string @@ -67,13 +67,17 @@ class MetadataTOOIbijvertegenwoordigendeorganeningekomenstukken { + tooiThemaUri: string + values: array } -class Thema { +class Attachment { + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + publicaties: integer + + title: string + + summary: string + + description: string + + labels: array + + url: string + + documentText: string + + type: string + + extension: string + + size: integer } class MetadataOpenCatalogiPubliccode { + tooiCategorieNaam: string @@ -117,13 +121,13 @@ class MetadataTOOIconvenanten { } class Index { + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string + + title: string + + summary: string + + description: string + + image: string + url: string + status: integer - + organisatie: object + + organization: object } class MetadataTOOIklachtoordelen { + tooiCategorieNaam: string @@ -152,30 +156,6 @@ class MetadataTOOIvergaderstukkenStaten-Generaal { + tooiThemaUri: string + values: array } -class Organisatie { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + afbeelding: string - + uuid: string - + oin: string - + tooi: string - + rsin: string - + naam: string -} -class Bijlage { - + id: string - + titel: string - + samenvatting: string - + beschrijving: string - + labels: array - + url: string - + documentText: string - + type: string - + extension: string - + size: integer -} class MetadataTOOIagenda’senbesluitenlijstenbestuurscolleges { + tooiCategorieNaam: string + tooiCategorieId: string @@ -233,6 +213,26 @@ class MetadataTOOIorganisatieenwerkwijze { + tooiThemaUri: string + values: array } +class Theme { + + id: string + + title: string + + summary: string + + description: string + + image: string + + publications: integer +} +class Organization { + + id: string + + title: string + + summary: string + + description: string + + image: string + + uuid: string + + oin: string + + tooi: string + + rsin: string + + name: string +} class MetadataTOOIadviezen { + tooiCategorieNaam: string + tooiCategorieId: string