Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated schemas to match stoplight and fixes to make it installable #30

Merged
merged 6 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions Installation/Schema/Attachment.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"title": "Attachment",
"$id": "https://openwoo.app/schemas/attachment.schema.json",
"$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
"version": "0.0.1",
"version": "0.0.2",
"type": "object",
"description": "An attachment object",
"tags": ["Open Index"],
Expand Down Expand Up @@ -44,17 +44,17 @@
"type": "array",
"description": "Possible labels on the attachment that are used to assess what kind of file it is"
},
"url": {
"accessURL": {
"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",
"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 thedocumentText, type, extensionand size` properties",
"required": true
},
"content": {
"downloadURL": {
"type": "string",
"format": "text",
"readOnly": true,
"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"
"format": "url",
"description": "The URL to download the document.",
"required": true
},
"type": {
"type": "string",
Expand Down Expand Up @@ -101,7 +101,7 @@
"type": "string",
"description": "Common European Framework of Reference (CEFR) for language level, see https://en.wikipedia.org/wiki/Common_European_Framework_of_Reference_for_Languages for a explanation and translation to ACTFL",
"example": "A1",
"oneof": ["0","A1","A2","B1","B2","C1","C2"],
"enum": ["0","A1","A2","B1","B2","C1","C2"],
"maxLength": 2
}
}
Expand All @@ -118,8 +118,16 @@
"readOnly": true,
"maxLength": 255,
"description": "**Generated** \nA file hash is essential for ensuring the uniqueness and integrity of files. It serves several critical purposes:\n\nUniqueness: Each file, regardless of its type, generates a unique hash value. Even a small change in the file content will result in a completely different hash, allowing for easy differentiation between files.\n\nIntegrity Verification: By comparing the hash value of a file at different times, one can verify that the file has not been altered. This is crucial for maintaining data integrity, as any unauthorized or accidental changes can be detected immediately.\n\nSecurity: Hashes play a vital role in security protocols. They ensure that the content has not been tampered with during transmission or storage, providing confidence in the file's authenticity.\n\nData Deduplication: In systems that store large amounts of data, file hashes help in identifying and eliminating duplicate files, thus saving storage space and improving efficiency.\n\nDigital Signatures and Certificates: Hashes are integral to the functioning of digital signatures and certificates, which verify the identity of the sender and ensure that the file has not been altered.\n\nOverall, file hashes are a fundamental tool in data management and cybersecurity, ensuring that files remain unique, intact, and secure."
}
},
},
"published": {
"type": "string"
},
"modified": {
"type": "string"
},
"license": {
"type": "string"
},
"required": [
"url"
]
Expand Down
5 changes: 3 additions & 2 deletions Installation/Schema/Organization.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"title": "Organization",
"$id": "https://openwoo.app/schemas/organization.schema.json",
"$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
"version": "0.0.1",
"version": "0.0.2",
"type": "object",
"description": "An organization that provides a publication or index",
"tags": ["Open Index"],
Expand Down Expand Up @@ -55,8 +55,9 @@
"immutable": true,
"description": "The RSIN of the Non-natural person being the organization that created the case. This must be a valid RSIN consisting of 9 digits and comply with the 11-test as described in https://en.wikipedia.org/wiki/Burgerservicenummer#11-proef."
},
"name": {
"pki": {
"type": "string",
"description": "Het PKI certificaat wat word gebruik om namens deze organisatie te publiceren",
"required": true
}
},
Expand Down
73 changes: 16 additions & 57 deletions Installation/Schema/Publication.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"title": "Publication",
"$id": "https://openwoo.app/schemas/publication.schema.json",
"$schema": "https://docs.commongateway.nl/schemas/Entity.schema.json",
"version": "0.0.1",
"version": "0.0.2",
"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.",
"tags": ["Open Index"],
Expand Down Expand Up @@ -94,7 +94,7 @@
"type": "string",
"description": "Attention! The publication object can only be included in an Open Index if the status is Published! The other statuses are intended for internal processing within the Woo Register.",
"required": true,
"oneOf": ["New, Revised, Rejected, Published, Withdrawn, Archived"]
"enum": ["New, Revised, Rejected, Published, Withdrawn, Archived"]
},
"attachments": {
"type": "array",
Expand All @@ -114,59 +114,8 @@
"description":"The urls of the theme's associated with this publication"
},
"data": {
"oneOf": [
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_vergaderstukken_decentrale_overheden.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_onderzoeksrapporten.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_convenanten.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_klachtoordelen.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_vergaderstukken_staten_generaal.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_bereikbaarheidsgegevens.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_beschikkingen.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_jaarplannen_en_jaarverslagen.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_verzoeken_en_besluiten.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_organisatie_en_werkwijze.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_adviezen.schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/CommonGateway/OpenIndex/main/Installation/Schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.schema.json"
}
]
"type": "array",
"required": true
},
"anonymization": {
"type": "object",
Expand Down Expand Up @@ -198,16 +147,26 @@
"type": "string",
"description": "Common European Framework of Reference (CEFR) for language level, see https://en.wikipedia.org/wiki/Common_European_Framework_of_Reference_for_Languages for a explanation and translation to ACTFL",
"example": "A1",
"oneof": ["0","A1","A2","B1","B2","C1","C2"],
"enum": ["0","A1","A2","B1","B2","C1","C2"],
"maxLength": 2
}
}
},
"published": {
"type": "string"
},
"modified": {
"type": "string"
},
"license": {
"type": "string"
}
},
"required": [
"title",
"summary",
"category",
"schema"
"schema",
"data"
]
}
2 changes: 1 addition & 1 deletion docs/schema/Attachment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An attachment object

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Attachment.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Attachment.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An externally found index that can be used as a source in federative search queries

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Index.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Index.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.oc_publiccode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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/main/docs/schema/Metadata.oc_publiccode.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.oc_publiccode.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.ods_agenda_item.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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/main/docs/schema/Metadata.ods_agenda_item.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.ods_agenda_item.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_adviezen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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/main/docs/schema/Metadata.tooi_adviezen.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_adviezen.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Agenda’s en besluitenlijsten van vergaderingen van diverse bestuurlijke organen.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_agendas_en_besluitenlijsten_bestuurscolleges.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_bereikbaarheidsgegevens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bereikbaarheidsinformatie van bestuursorganen en hun organisatieonderdelen.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_bereikbaarheidsgegevens.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_beschikkingen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Beschikkingen, uitgezonderd specifieke categorieën.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_beschikkingen.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_beschikkingen.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Ingekomen stukken bij diverse overheidsorganen, uitgezonderd bepaalde vertrouwelijke informatie of individuele gevallen.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_bij_vertegenwoordigende_organen_ingekomen_stukken.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_convenanten.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Convenanten.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_convenanten.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_convenanten.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Jaarplannen en jaarverslagen van bestuursorganen over hun taakuitvoering.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_jaarplannen_en_jaarverslagen.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_klachtoordelen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Schriftelijke oordelen in klachtprocedures.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_klachtoordelen.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_klachtoordelen.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_onderzoeksrapporten.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Onderzoeksrapporten opgesteld op verzoek van bestuursorganen die geen taakuitvoering zijn, gericht op organisatie of beleidsevaluatie.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_onderzoeksrapporten.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_onderzoeksrapporten.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Ontwerpen van wetgeving waarover extern advies is gevraagd, inclusief de adviesaanvraag.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_ontwerpen_van_wet_en_regelgeving_met_adviesaanvraag.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_organisatie_en_werkwijze.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Informatie over de organisatie en werkwijze van bestuursorganen.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_organisatie_en_werkwijze.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_organisatie_en_werkwijze.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Overige besluiten van algemene strekking.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_overige_besluiten_van_algemene_strekking.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/main/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_subsidieverplichtingen_anders_dan_met_beschikking.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Vergaderstukken en verslagen van diverse decentrale overheden en hun commissies.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_vergaderstukken_decentrale_overheden.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_vergaderstukken_decentrale_overheden.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Vergaderstukken en verslagen van de Staten-Generaal, uitgezonderd vertrouwelijke informatie verstrekt aan de Staten-Generaal.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_vergaderstukken_staten_generaal.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Metadata.tooi_verzoeken_en_besluiten.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Inhoud van schriftelijke Woo-verzoeken en besluiten daarop, inclusief verstrekte informatie.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_verzoeken_en_besluiten.svg)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Wetten en andere algemeen verbindende voorschriften.

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Metadata.tooi_wetten_en_algemeen_verbindende_voorschriften.svg)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An organization that provides a publication or index

![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/main/docs/schema/Organization.svg)
![Class Diagram](https://github.com/CommonGateway/OpenIndex/blob/update-schemas/docs/schema/Organization.svg)

## Properties

Expand Down
Loading
Loading