Project

General

Profile

Project activity #30874

closed

Project activity #30766: Documenten API Spec updaten naar 1.5

Update Documenten API naar versie 1.3 van de DRC spec

Added by Erik Hoogland 3 months ago. Updated 2 months ago.

Status:
Resolved
Priority:
P4 Normal
Assignee:
Target version:
Contezza Productontwikkeling - Contezza Development 2025.03
Start date:
06/02/2025
Due date:
% Done:

100%

Estimated time:

Description

De huidige DRC implementatie is van versie 1.1/1.2. Deze loopt al enige tijd achter op de nieuwe specificatie, namelijk 1.5.

In dit ticket, update de implementatie tot en met 1.3.0. Enige functies, zoals PATCH/PUT issue (#24264) zijn mogelijk al opgelost.

https://github.com/VNG-Realisatie/documenten-api/blob/develop/CHANGELOG.rst

Met name 1.4.x is een major wijziging dus daar zal veel tijd inzitten.
Belangrijk is om van laag naar hoog te werken:
  • 1.2.0 major update
    • API gewijzigd, dus nieuwe tests schrijven en dan implementeren
  • 1.2.1 minor update
    • Geen API wijziging
    • Niet duidelijk wat dit betekent added resource `telefoonnummer` to verzending
  • 1.2.2 minor update
    • API gewijzigd, dus nieuwe tests schrijven en dan implementeren
  • 1.2.3 minor update
    • Geen API wijziging, kan overgeslagen worden
  • 1.3.0 minor update
    • Geen API wijziging, wel wijziging van de functionaliteit/tests controleren of dit nog goed gaat
1.3.0 (2023-03-29) --> Test schrijven om te kijken of dit een probleem is
===========
Implementation changes
----------------------
* Changed permissions for EnkelVoudigInformatieObject such that PUT and PATCH can be applied to `InformatieObject` (`Issue 1777`_):
1.2.3 (2022-03-01) --> Geen API spec, dus kunnen we negeren
===========
Implementation changes
----------------------
* Added ``ENV`` variable to turn off Notifications when running in a Container
1.2.2 (2022-02-22)
===========
API spec bugfixes
----------------
* Fixed description of ``faxnummer``, ``telefoonnummer``, ``mijnOverheid and ``emailadres`` in ``Verzending`` resource
* Fixed ``telefoonnnummer`` not shown in openapi.yaml
* Sets baseUrl to production server
1.2.1 (2022-02-21)
==========
* added resource `telefoonnummer` to verzending
* removed double prefix `/api/v1` in openapi.yaml
1.2.0 (2022-12-19)
===========
API spec New Features
----------------
* Added Validation ``locked`` documents cannot be deleted. (`Issue 1956`_):
* Added new ``/enkelvoudiginformatieobjecten/_zoek`` endpoint which allows users to search ``EnkelvoudingInformatieObject``s through the ``uuid`` field (`Issue 1881`_):
* Add ``Verzending`` resource (`Issue 1770`_): (`Issue 1785`_): (`Issue 1856`_):
* Add new ``documenten.geforceerd-bijwerken`` scope which allows editing  ``EnkelvoudingInformatieObject`` with a status which equals ``definitief`` (`Issue 1859`_):
* Added missing RGBZ attributes for existing resources to support TMLO. (`Issue 1884`_):
Actions #1

Updated by Erik Hoogland 3 months ago

  • Status changed from Backlog to In Progress
Actions #2

Updated by Erik Hoogland 3 months ago

Voor 1.2.0:

De volgende punten worden al ondersteun:
  • Added Validation ``locked`` documents cannot be deleted. (`Issue 1956`_):
  • Added new ``/enkelvoudiginformatieobjecten/_zoek`` endpoint which allows users to search ``EnkelvoudingInformatieObject``s through the ``uuid`` field (`Issue 1881`_):

Voor het eerste punt heb ik de test en de foutmelding aangepast, om beter overeen te komen met de referentie implementatie

Punt "Add new ``documenten.geforceerd-bijwerken`` scope which allows editing ``EnkelvoudingInformatieObject`` with a status which equals ``definitief`` (`Issue 1859`_)" wordt nu verder ontwikkeld.

Actions #3

Updated by Erik Hoogland 3 months ago

Toevoegen verschijningsvorm aan EnkelvoudigInformatieObject, inclusief test.
Zover ik kan zien is dat het enige ontbrekende element uit Issue 1884 van VNG

Actions #4

Updated by Erik Hoogland 3 months ago

Toevoeging GET en POST van 'Verzendingen', met nog een aantal TODO's
- POST heeft nog geen speciefieke validaties, enkel wat nodig is om uit te voeren
- POST en GET geven nu nog velden niet terug bij geen waarden, moet als leeg veld teruggegeven worden
- GET Is nog niet getest voor list functie
- Tests zijn nog niet geheel compleet

Actions #5

Updated by Erik Hoogland 3 months ago

Toegevoegd voor Verzendingen
- Toevoegen ontbrekende parameters aan mapping bij create
- Correctie test Get uuid
- Uitwerken Get list incl. test
- Uitwerken PUT, PATCH en Delete incl. tests
- Cleanup duplicate code

Nog te doen voor verzendingen:
- Uitwerken validaties voor getVerzendingenPropertiesMap
- Uitzoeken extra validaties per operatie
- Uitwerken HEAD operatie
- Extra test toevoegen indien nodig
- Documentatie bijwerken

Actions #6

Updated by Erik Hoogland 3 months ago

  • Openstaande punten voor verzendingen toegevoegd
  • Tests voor 1.3.0 toegevoegd, functinaliteit had geen aanpassing nodig
  • openapi.yml aangepast naar versie 1.3.0

Enig nog openstaand punt is ``documenten.geforceerd-bijwerken`` scope. Ik weet niet zeker of mijn code of mijn tests fout zijn, hiervor zal ik navraag doen bij Rick.
Ik heb ook aanwijzingen gevonden dat dit niet volledig is geïmplementeerd bij de referentie implementatie

Actions #7

Updated by Erik Hoogland 3 months ago

Extra test voor Verzendingen toegevoegd, vanuit https://github.com/VNG-Realisatie/documenten-api/blob/1.3.0/src/drc/api/tests/test_validation.py.
Werkt tegen refentie implementatie, geeft nog errors tegen onze implementatie m.b.t. adressen

Actions #8

Updated by Erik Hoogland 3 months ago

  • Status changed from In Progress to Feedback
  • Assignee changed from Erik Hoogland to Rick de Rooij

@Rick de Rooij Kan jij dit reviewen?

Alle testen voor verzendingen werken nu tegen Alfresco en de DRC.
Voor het punt van documenten.geforceerd-bijwerken is een apart ticket aangemaakt, #31024. Dit wordt dan ook geen onderdeel van onze oplevering nu.

Alle andere punten t/m 1.3.0 zitten er wel in.

Actions #9

Updated by Rick de Rooij 2 months ago

  • Assignee changed from Rick de Rooij to Erik Hoogland

Hi Erik,

ik heb nog geen mr van je. Zou je er ook voor willen zorgen dat je branch up-to-date is met de wijzigingen van main?

Gr, Rick

Actions #10

Updated by Erik Hoogland 2 months ago · Edited

  • Assignee changed from Erik Hoogland to Rick de Rooij

Heb voor 23.x en 7.x een merge request aangemaakt, beide zijn nu up-to-date met hun respectievelijke main branch. Voor beide branches gaan alle testen goed.

23.x: https://git.contezza.nl/community/alfresco-documenten-api/-/merge_requests/2
7.x: https://git.contezza.nl/community/alfresco-documenten-api/-/merge_requests/3

Actions #11

Updated by Rick de Rooij 2 months ago

  • Assignee changed from Rick de Rooij to Erik Hoogland

Hi Erik,

Ziet er goed uit. Tests ook uitgevoerd en geen fouten. Nog een aantal kleine wijzigingen graag doorvoeren.

Gr, Rick

Actions #12

Updated by Erik Hoogland 2 months ago

  • Target version set to Contezza Development 2025.03
Actions #13

Updated by Erik Hoogland 2 months ago

  • Assignee changed from Erik Hoogland to Rick de Rooij

@Rick de Rooij Alle punten zijn aangepast, m.u.v. Validatie op postcode, zoals eerder besproken.
Dit is niet meegenomen, omdat de huidige wijze in lijn is met de DRC referentie implementatie, ookal is deze niet geheel logisch.

Verzendingen testen in beide branches opnieuw uitgevoerd en geen fouten gevonden.

Actions #14

Updated by Rick de Rooij 2 months ago

  • Status changed from Feedback to Resolved
  • % Done changed from 0 to 100

Also available in: Atom PDF