From fa4ef7a4d854e6c2d27356eba1c61f69fd749d3e Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 6 Nov 2024 16:01:00 +0100 Subject: [PATCH 1/4] Patch operatie toegevoegd aan rollen --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 229 ++++++++++++++++++ 1 file changed, 229 insertions(+) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 9d497bd6..a8b5eebd 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -2492,6 +2492,235 @@ paths: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK + patch: + operationId: rol_partial_update + summary: Werk een ROL deels bij. + description: Werk een ROL deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - rollen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error /statussen: get: operationId: status_list From 5b6823522c66bd91840efbc84eff60a8f2cbab13 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 7 Nov 2024 11:14:33 +0100 Subject: [PATCH 2/4] Changed PATCH into PUT --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index a8b5eebd..19d574e7 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -2492,10 +2492,10 @@ paths: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK - patch: - operationId: rol_partial_update - summary: Werk een ROL deels bij. - description: Werk een ROL deels bij. + put: + operationId: rol_update + summary: Werk een ROL in zijn geheel bij. + description: Werk een ROL in zijn geheel bij. parameters: - in: path name: uuid From c72d4bcbcf0cf523814db047571ac4141b9192d9 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 7 Nov 2024 11:42:22 +0100 Subject: [PATCH 3/4] Description aangepast met validatieregels --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 19d574e7..01bae407 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -2495,7 +2495,10 @@ paths: put: operationId: rol_update summary: Werk een ROL in zijn geheel bij. - description: Werk een ROL in zijn geheel bij. + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `betrokkene`\ + \ en `betrokkeneType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `betrokkeneIdentificatie` gevalideerd tegen de betrokkeneType discriminator." parameters: - in: path name: uuid From 7492f1a382adde4337e54833be742f3a173f458a Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:29:49 +0100 Subject: [PATCH 4/4] Validatie op rol_update operatie minder streng gemaakt --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 01bae407..06963764 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -2496,9 +2496,7 @@ paths: operationId: rol_update summary: Werk een ROL in zijn geheel bij. description: - "**Er wordt gevalideerd op** \n- De attributen `zaak`, `betrokkene`\ - \ en `betrokkeneType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ - \ `betrokkeneIdentificatie` gevalideerd tegen de betrokkeneType discriminator." + "**Validatieregel**: indien opgegeven, dan wordt `betrokkeneIdentificatie` gevalideerd tegen de betrokkeneType discriminator." parameters: - in: path name: uuid