Skip to content

Commit

Permalink
Production release to version v1.4.0 (#215)
Browse files Browse the repository at this point in the history
* adds develop branch with ci job

* update eio validation such that status==definitief does not block update/patch (#212)

* Update help text for deprecated resources in openapi.yaml (#211)

* fixed signals url (#210)

* added Inclusions to documenten api (#209)

**Restructured API Enhancements and Bug Fixes**

- **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.
- **Updated:** 'exclusions.py' to handle non-type objects more effectively during iteration.
- **Updated:** Modified 'expfield' to 'sub_field' for clarity and precision in naming.

These changes collectively enhance the API with new features, bug fixes, and code improvements. The 'trefwoorden' attribute, 'Inclusions' feature, and the 'expand' model enrich data handling, while code fixes and adjustments contribute to a more reliable and user-friendly system.

* Production release to version v1.4.0 (#214)

---------

Co-authored-by: MatthijsBekendam <47739550+MatthijsBekendam@users.noreply.github.com>
  • Loading branch information
joerivrij and MatthijsBekendam authored Aug 22, 2023
1 parent e7aa7bc commit 5e5221b
Show file tree
Hide file tree
Showing 29 changed files with 1,197 additions and 224 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[bumpversion]
commit = False
tag = False
current_version = 1.3.0
current_version = 1.4.0
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)([-](?P<release>(rc|alpha))+(?P<build>\d+))?
serialize =
{major}.{minor}.{patch}-{release}{build}
Expand Down
38 changes: 38 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,44 @@
Wijzigingen
===========

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)
===========

Expand Down
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Documenten API
==============

:Version: 1.3.0
:Version: 1.4.0
:Source: https://github.com/VNG-Realisatie/documenten-api
:Keywords: zaken, zaakgericht werken, GEMMA, RGBZ, DRC

Expand All @@ -24,6 +24,8 @@ Versie Release datum API specificatie
master n.v.t. `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-documentregistratiecomponent/master/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/documenten-api/blob/master/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/documenten-api/blob/master/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-documentregistratiecomponent/master/src/openapi.yaml>`_
(`verschillen <https://github.com/VNG-Realisatie/documenten-api/compare/stable/1.2.x..master>`_)
1.4.0 2023-08-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/stable/1.4.0/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.4.0/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.4.0/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/stable/1.4.0/src/openapi.yaml>`_
1.3.x 2023-03-29 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/stable/1.1.x/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.1.x/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.1.x/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/stable/1.1.x/src/openapi.yaml>`_
(`verschillen <https://github.com/VNG-Realisatie/documenten-api/compare/stable/1.2.x..master>`_)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "drc",
"version": "1.3.0",
"version": "1.4.0",
"description": "drc referentie implementatie API",
"main": "src/index.js",
"directories": {
Expand Down
2 changes: 1 addition & 1 deletion src/drc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import re
from collections import namedtuple

__version__ = "1.3.0"
__version__ = "1.4.0"
__author__ = "VNG Realisatie"
__homepage__ = "https://github.com/VNG-Realisatie/documenten-api"
__docformat__ = "restructuredtext"
Expand Down
Loading

0 comments on commit 5e5221b

Please sign in to comment.