Actions
Project activity #30766
closedDocumenten API Spec updaten naar 1.5
Start date:
06/02/2025
Due date:
% Done:
100%
Estimated time:
(Total: 0.00 h)
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.
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.4.0 major update
- API gewijzigd, dus nieuwe tests schrijven en dan implementeren, met name stukje expand wat totaal nieuw is
- 1.4.1 minor update
- Geen API wijzigingen kijken of de tests nog voldoen voor GET bestandsdelen
- 1.4.2 minor update
- functionaliteit gewijzigd, test herzien
- 1.4.3 minor update
- functionaliteit gewijzigd, test herzien POST bestandsdelen
- 1.5.0 minor update
- API gewijzigd, dus nieuwe tests schrijven en dan implementeren
1.5.0 (2024-25-03) =========== - **Added:** Fields on EIO (inhoudIsVervallen). =========== 1.4.3 (2023-10-24) =========== - **Changed:** `lock` attribute shows up in EIO.bestandsdelen POST response after creating an EIO. =========== 1.4.2 (2023-09-25) =========== - **Changed:** added expand queryparameter to /zoek - **Changed:** bestandsdeel serializer to include lock attribute =========== 1.4.1 (2023-08-29) =========== - **Changed:** schema generation such that the `lock` attribute shows up in EIO.bestandsdelen GET response. Implementation changes ---------------------- 1.4.0 (2023-08-22) =========== Implementation changes ---------------------- `Issue 2247`_: - **Added:** Implementation of 'trefwoorden' to the 'EnkelvoudigInformatieobject' model for improved metadata organization. - **Added:** Integration of 'trefwoorden' filter to facilitate precise content filtering. - **Changed:** Adjusted test suite to accommodate the new 'trefwoorden' attribute. - **Added:** Introduction of 'expand' feature to the 'documenten' API, enabling more comprehensive data retrieval. - **Changed:** Replaced hard-coded search logic for models and serializers. - **Changed:** Renamed '_inclusions' to '_expand' for better clarity and consistency. - **Changed:** Updated the 'expand' model to resolve previous errors and improve performance. - **Fixed:** Corrected the URL for signals to ensure proper functionality. - **Updated:** Expanded OpenAPI Specification (OAS) to include the 'expand' feature. - **Added:** Custom renderer to enable camel case formatting for improved API response consistency. - **Fixed:** Adjusted renderers to handle nested dictionaries and replace 'Expand' with '_expand'. - **Updated:** 'zrc expansions.py' for alignment with the latest enhancements. - **Fixed:** Handled scenarios involving empty values more gracefully. - **Fixed:** Corrected an issue where a URL within a nested dictionary caused a server error. - **Fixed:** signals url and removed notifications mixin #210 - **Updated:** 'exclusions.py' to handle non-type objects more effectively during iteration. - **Updated:** Modified 'expfield' to 'sub_field' for clarity and precision in naming. `Issue 2241`_: - **Updated:** eio validation such that status==definitief does not block update/patch `Issue 2304`_: - **Updated:** help text for deprecated resources (verzenddatum and ontvangstdatum in openapi.yaml .. _Issue 2247: https://github.com/VNG-Realisatie/gemma-zaken/issues/2247 .. _Issue 2241: https://github.com/VNG-Realisatie/gemma-zaken/issues/2241 .. _Issue 2304: https://github.com/VNG-Realisatie/gemma-zaken/issues/2304 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`_):
- API gewijzigd, dus nieuwe tests schrijven en dan implementeren
Actions