diff --git a/src/openapi.yaml b/src/openapi.yaml index 931aefc3..3d0eef1b 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Documenten API - version: 1.5.0 + version: 1.4.3 description: "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\n\ In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\n\ @@ -83,7 +83,6 @@ paths: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BestandsDeelRequest' - required: true security: - JWT-Claims: - documenten.bijwerken @@ -1104,7 +1103,8 @@ paths: operationId: enkelvoudiginformatieobject_update description: "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ - \ INFORMATIEOBJECT." + \ INFORMATIEOBJECT. \n \n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n\ + - status NIET `definitief`" summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. parameters: - in: path @@ -1292,7 +1292,8 @@ paths: operationId: enkelvoudiginformatieobject_partial_update description: "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ - \ INFORMATIEOBJECT." + \ INFORMATIEOBJECT. \n\n**Er wordt gevalideerd op**\n - correcte `lock` waarde\n\ + \ - status NIET `definitief`" summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. parameters: - in: path @@ -5451,6 +5452,7 @@ components: title: voltooid lock: type: string + readOnly: true description: Hash string, which represents id of the lock of related informatieobject title: lock required: @@ -5468,13 +5470,6 @@ components: writeOnly: true description: De (binaire) bestandsinhoud van dit specifieke bestandsdeel. title: inhoud - lock: - type: string - minLength: 1 - description: Hash string, which represents id of the lock of related informatieobject - title: lock - required: - - lock BestandsDeelResponse: type: object properties: @@ -5927,16 +5922,11 @@ components: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd - teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element." @@ -6096,13 +6086,6 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - inhoudIsVervallen: - type: boolean - nullable: true - description: - Geeft aan of de inhoud van het informatieobject vervallen (dus - niet langer geldig) is. - title: inhoud is vervallen required: - auteur - beginRegistratie @@ -6200,16 +6183,11 @@ components: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd - teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element." @@ -6343,13 +6321,6 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - inhoudIsVervallen: - type: boolean - nullable: true - description: - Geeft aan of de inhoud van het informatieobject vervallen (dus - niet langer geldig) is. - title: inhoud is vervallen required: - auteur - bronorganisatie @@ -6449,16 +6420,11 @@ components: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd - teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element." @@ -6618,13 +6584,6 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - inhoudIsVervallen: - type: boolean - nullable: true - description: - Geeft aan of de inhoud van het informatieobject vervallen (dus - niet langer geldig) is. - title: inhoud is vervallen required: - auteur - beginRegistratie @@ -6722,16 +6681,11 @@ components: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd - teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element." @@ -6865,13 +6819,6 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - inhoudIsVervallen: - type: boolean - nullable: true - description: - Geeft aan of de inhoud van het informatieobject vervallen (dus - niet langer geldig) is. - title: inhoud is vervallen lock: type: string writeOnly: true @@ -7431,16 +7378,11 @@ components: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd - teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element." @@ -7574,13 +7516,6 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - inhoudIsVervallen: - type: boolean - nullable: true - description: - Geeft aan of de inhoud van het informatieobject vervallen (dus - niet langer geldig) is. - title: inhoud is vervallen lock: type: string writeOnly: true @@ -7889,16 +7824,11 @@ components: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd - teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element." @@ -8058,13 +7988,6 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - inhoudIsVervallen: - type: boolean - nullable: true - description: - Geeft aan of de inhoud van het informatieobject vervallen (dus - niet langer geldig) is. - title: inhoud is vervallen required: - auteur - beginRegistratie @@ -8086,10 +8009,8 @@ components: StatusEnum: enum: - in_bewerking - - concept - - definitief - ter_vaststelling - - vastgesteld + - definitief - gearchiveerd type: string UnlockEnkelvoudigInformatieObjectRequest: diff --git a/src/resources.md b/src/resources.md index 6754a9c3..c4507ab4 100755 --- a/src/resources.md +++ b/src/resources.md @@ -60,7 +60,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Rgbz_1.0/doc/o | volgnummer | Een volgnummer dat de volgorde van de bestandsdelen aangeeft. | integer | ja | ~~C~~​R​~~U~~​~~D~~ | | omvang | De grootte van dit specifieke bestandsdeel. | integer | ja | ~~C~~​R​~~U~~​~~D~~ | | voltooid | Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen. | boolean | ja | ~~C~~​R​~~U~~​~~D~~ | -| lock | Hash string, which represents id of the lock of related informatieobject | string | ja | C​R​U​D | +| lock | Hash string, which represents id of the lock of related informatieobject | string | ja | ~~C~~​R​~~U~~​~~D~~ | ## EnkelvoudigInformatieObject @@ -91,10 +91,8 @@ Uitleg bij mogelijke waarden: Uitleg bij mogelijke waarden: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. -* `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. -* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. -* `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. +* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. | | nee | C​R​U​D | | formaat | Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml | string | nee | C​R​U​D | | taal | Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html | string | ja | C​R​U​D | @@ -119,7 +117,6 @@ Uitleg bij mogelijke waarden: | locked | Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. | boolean | ja | ~~C~~​R​~~U~~​~~D~~ | | bestandsdelen | | array | ja | ~~C~~​R​~~U~~​~~D~~ | | trefwoorden | Een lijst van trefwoorden gescheiden door comma's. | array | nee | C​R​U​D | -| inhoudIsVervallen | Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. | boolean | nee | C​R​U​D | ## Gebruiksrechten