Master into Develop

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = False
 tag = False
-current_version = 1.4.0
+current_version = 1.4.1
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)([-](?P<release>(rc|alpha))+(?P<build>\d+))?
 serialize =
 	{major}.{minor}.{patch}-{release}{build}

CHANGELOG.rst

@@ -1,6 +1,13 @@
 ===========
 Wijzigingen
 ===========
+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)
 ===========

README.rst

@@ -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.1       2023-08-29      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/1.4.1/src/openapi.yaml>`_,                                                                 `Scopes <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.4.1/src/autorisaties.md>`_                      `Berichtkenmerken <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.4.1/src/notificaties.md>`_
+                            `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/1.4.1/src/openapi.yaml>`_
 1.4.0       2023-08-22      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/documenten-api/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/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.3.x/src/openapi.yaml>`_,                                                         `Scopes <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.3.x/src/autorisaties.md>`_                       `Berichtkenmerken <https://github.com/VNG-Realisatie/documenten-api/blob/stable/1.3.x/src/notificaties.md>`_

package.json

@@ -1,6 +1,6 @@
 {
   "name": "drc",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "drc referentie implementatie API",
   "main": "src/index.js",
   "directories": {

src/drc/__init__.py

@@ -7,7 +7,7 @@
 import re
 from collections import namedtuple
 
-__version__ = "1.4.0"
+__version__ = "1.4.1"
 __author__ = "VNG Realisatie"
 __homepage__ = "https://github.com/VNG-Realisatie/documenten-api"
 __docformat__ = "restructuredtext"

src/drc/api/serializers/bestandsdeel.py

@@ -49,3 +49,9 @@ def validate(self, attrs):
             )
 
         return valid_attrs
+
+
+class SchemaBestandsDeelSerializer(BestandsDeelSerializer):
+    lock = serializers.CharField(
+        help_text="Hash string, which represents id of the lock of related informatieobject",
+    )

src/drc/api/serializers/enkelvoudig_informatieobject.py

@@ -20,7 +20,10 @@
 
 from drc.api.auth import get_ztc_auth
 from drc.api.fields import AnyBase64File
-from drc.api.serializers.bestandsdeel import BestandsDeelSerializer
+from drc.api.serializers.bestandsdeel import (
+    BestandsDeelSerializer,
+    SchemaBestandsDeelSerializer,
+)
 from drc.api.utils import create_filename, merge_files
 from drc.api.validators import StatusValidator
 from drc.datamodel.constants import ChecksumAlgoritmes, OndertekeningSoorten, Statussen
@@ -497,3 +500,9 @@ class EIOZoekSerializer(serializers.Serializer):
         child=serializers.UUIDField(),
         help_text=_("Array of unieke resource identifiers (UUID4)"),
     )
+
+
+class SchemaEIOSerializer(EnkelvoudigInformatieObjectSerializer):
+    bestandsdelen = SchemaBestandsDeelSerializer(
+        source="canonical.bestandsdelen", many=True, read_only=True
+    )

src/drc/api/tests/test_dso_api_strategy.py

@@ -23,7 +23,7 @@ def test_api_19_documentation_version_yaml(self):
     @override_settings(ROOT_URLCONF="drc.api.tests.test_urls")
     def test_api_24_version_header(self):
         response = self.client.get("/test-view")
-        self.assertEqual(response["API-version"], "1.4.0")
+        self.assertEqual(response["API-version"], "1.4.1")
 
 
 class DSOApi50Tests(APITestCase):

src/drc/api/views/bestandsdeel.py

@@ -9,6 +9,7 @@
 from drc.api.schema import BestandsDeelSchema
 from drc.api.scopes import SCOPE_DOCUMENTEN_BIJWERKEN
 from drc.api.serializers import BestandsDeelSerializer
+from drc.api.serializers.bestandsdeel import SchemaBestandsDeelSerializer
 from drc.datamodel.models.bestandsdeel import BestandsDeel
 
 

src/drc/api/views/enkelvoudig_informatieobject.py

@@ -51,7 +51,10 @@
     LockEnkelvoudigInformatieObjectSerializer,
     UnlockEnkelvoudigInformatieObjectSerializer,
 )
-from drc.api.serializers.enkelvoudig_informatieobject import EIOZoekSerializer
+from drc.api.serializers.enkelvoudig_informatieobject import (
+    EIOZoekSerializer,
+    SchemaEIOSerializer,
+)
 from drc.api.views.constants import REGISTRATIE_QUERY_PARAM, VERSIE_QUERY_PARAM
 from drc.datamodel.models import EnkelvoudigInformatieObject
 
@@ -256,7 +259,8 @@ def get_serializer_class(self, *args, **kwargs):
         return EnkelvoudigInformatieObjectSerializer
 
     @extend_schema(
-        parameters=[VERSIE_QUERY_PARAM, REGISTRATIE_QUERY_PARAM, EXPAND_QUERY_PARAM]
+        parameters=[VERSIE_QUERY_PARAM, REGISTRATIE_QUERY_PARAM, EXPAND_QUERY_PARAM],
+        responses=SchemaEIOSerializer,
     )
     def retrieve(self, request, *args, **kwargs):
         return super().retrieve(request, *args, **kwargs)

src/drc/conf/api.py

@@ -2,7 +2,7 @@
 
 from vng_api_common.conf.api import *  # noqa - imports white-listed
 
-API_VERSION = "1.4.0"
+API_VERSION = "1.4.1"
 
 REST_FRAMEWORK = BASE_REST_FRAMEWORK.copy()
 REST_FRAMEWORK["PAGE_SIZE"] = 100