From 46640c0682dd6315de2c1eedc6b1682c96bbf347 Mon Sep 17 00:00:00 2001 From: SonnyBA Date: Wed, 22 Jan 2025 10:57:30 +0100 Subject: [PATCH] [#513] Release 3.0.0 (#149) --------- Co-authored-by: Sonny Bakker --- .bumpversion.cfg | 6 +++- CHANGELOG.rst | 47 +++++++++++++++++++++++++++++ README.NL.rst | 40 +++++++++++++----------- README.rst | 40 +++++++++++++----------- package-lock.json | 4 +-- package.json | 2 +- publiccode.yaml | 4 +-- src/objecttypes/api/v2/openapi.yaml | 6 ++++ src/objecttypes/api/v2/views.py | 26 ++++++++++++++-- 9 files changed, 133 insertions(+), 42 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index bdccf040..cea8ccf5 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,11 +1,15 @@ [bumpversion] commit = False tag = False -current_version = 2.2.2 +current_version = 3.0.0 [bumpversion:file:README.rst] +search = :Version: {current_version} +replace = :Version: {new_version} [bumpversion:file:README.NL.rst] +search = :Version: {current_version} +replace = :Version: {new_version} [bumpversion:file:package.json] search = "version": "{current_version}", diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 9ec19cc2..7277d6ca 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,53 @@ Change history ============== +3.0.0 (2025-01-22) +------------------ + +**Breaking changes** + +* removed v1 endpoints [objects-api/issues/#453] + +2.3.0 (2025-01-10) +------------------ + +**Breaking changes** + +* upgraded ``django-setup-configuration`` to ``0.5.0`` + +.. warning:: + + Previous configuration files used for ``setup_configuration`` do not work. + See the `documentation `_ + for the available settings that can now be configured through ``setup_configuration``. + +* added support for configuring token authorizations through ``django-setup-configuration`` + version ``0.4.0`` [#481] +* added support for configuring ``mozilla-django-oidc-db`` through ``django-setup-configuration`` + version ``0.4.0`` [#480] + +**New features** + +* updated OAF version to 0.9.1. This upgrade allows admin users managing their sessions through the admin. + +**Bugfixes and QOL** + +* fixed ``latest`` docker image tag not being pushed [open-api-framework/#92] +* updated zgw-consumers to 0.35.1 [open-api-framework/#66] + +.. warning:: + + Configuring external services is now done through the ``Service`` model. This + replaces the ``APICredential`` model in the admin interface. A data migration + was added to move to the `Service` model. It is advised to verify the ``Service`` + instances in the admin to check that the data migration was ran as expected. + +**Project maintenance** + +* security updates [open-api-framework/#93] +* switched from ``pip-compile`` to ``uv`` [open-api-framework/#81] +* implementend open-api-workflows [open-api-framework/#13] + 2.2.2 (2024-10-01) ------------------ diff --git a/README.NL.rst b/README.NL.rst index 64d70bf1..b07dea39 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -2,7 +2,7 @@ Objecttypen API =============== -:Version: 2.2.2 +:Version: 3.0.0 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objecten, assets, zaakobjecten @@ -31,22 +31,28 @@ API specificatie |lint-oas| |generate-sdks| |generate-postman-collection| -============== ============== ============================= -Versie Release datum API specificatie -============== ============== ============================= -latest n/a `ReDoc `_, - `Swagger `_, - (`verschillen `_) -2.2.2 2022-08-23 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.2.0 2022-06-24 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.0.0 2021-10-04 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -============== ============== ============================= +================= ============== ============================= +Applicatie versie Release datum API specificatie +================= ============== ============================= +latest n/a `ReDoc `_, + `Swagger `_, + (`verschillen `_) +3.0.0 2025-01-22 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.3.0 2025-01-10 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.2.2 2022-08-23 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.2.0 2022-06-24 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.0.0 2021-10-04 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +================= ============== ============================= Vorige versies worden nog 6 maanden ondersteund nadat de volgende versie is uitgebracht. diff --git a/README.rst b/README.rst index 79ef3bac..23471b94 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Objecttypes API =============== -:Version: 2.2.2 +:Version: 3.0.0 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objects, assets, zaakobjecten @@ -30,22 +30,28 @@ API specification |lint-oas| |generate-sdks| |generate-postman-collection| -============== ============== ============================= -Version Release date API specification -============== ============== ============================= -latest n/a `ReDoc `_, - `Swagger `_, - (`diff `_) -2.2.2 2022-08-23 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.2.0 2022-06-24 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.0.0 2021-10-04 `ReDoc `_, - `Swagger `_ - (`diff `_) -============== ============== ============================= +=================== ============== ============================= +Application version Release date API specification +=================== ============== ============================= +latest n/a `ReDoc `_, + `Swagger `_, + (`diff `_) +3.0.0 2025-01-22 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.3.0 2025-01-10 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.2.2 2022-08-23 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.2.0 2022-06-24 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.0.0 2021-10-04 `ReDoc `_, + `Swagger `_ + (`diff `_) +=================== ============== ============================= Previous versions are supported for 6 month after the next version is released. diff --git a/package-lock.json b/package-lock.json index e45bc2a8..e7c6f9f7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "objecttypes", - "version": "2.2.2", + "version": "3.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "objecttypes", - "version": "2.2.2", + "version": "3.0.0", "license": "EUPL", "dependencies": { "microscope-sass": "latest", diff --git a/package.json b/package.json index 3872a904..2e9f7343 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "objecttypes", - "version": "2.2.2", + "version": "3.0.0", "description": "objecttypes project", "main": "src/objecttypes/static/bundles/objecttypes-js.js", "directories": { diff --git a/publiccode.yaml b/publiccode.yaml index 08770839..98b85228 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -7,8 +7,8 @@ publiccodeYmlVersion: '0.2' name: Objecttypes API url: 'http://github.com/maykinmedia/objecttypes-api.git' softwareType: standalone/backend -softwareVersion: 2.2.2 -releaseDate: '2021-01-13' +softwareVersion: 3.0.0 +releaseDate: '2025-01-22' logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png' platforms: - web diff --git a/src/objecttypes/api/v2/openapi.yaml b/src/objecttypes/api/v2/openapi.yaml index 226ac23f..3dff2a0a 100644 --- a/src/objecttypes/api/v2/openapi.yaml +++ b/src/objecttypes/api/v2/openapi.yaml @@ -111,6 +111,7 @@ paths: /objecttypes/{objecttype_uuid}/versions: get: operationId: objectversion_list + description: Retrieve all versions of an OBJECTTYPE parameters: - in: path name: objecttype_uuid @@ -144,6 +145,7 @@ paths: description: OK post: operationId: objectversion_create + description: Create an OBJECTTYPE with the given version. parameters: - in: header name: Content-Type @@ -179,6 +181,7 @@ paths: /objecttypes/{objecttype_uuid}/versions/{version}: get: operationId: objectversion_read + description: Retrieve an OBJECTTYPE with the given version. parameters: - in: path name: objecttype_uuid @@ -208,6 +211,7 @@ paths: description: OK put: operationId: objectversion_update + description: Update an OBJECTTYPE with the given version. parameters: - in: header name: Content-Type @@ -250,6 +254,7 @@ paths: description: OK patch: operationId: objectversion_partial_update + description: Partially update an OBJECTTYPE with the given version. parameters: - in: header name: Content-Type @@ -292,6 +297,7 @@ paths: description: OK delete: operationId: objectversion_delete + description: Destroy the given OBJECTTYPE. parameters: - in: path name: objecttype_uuid diff --git a/src/objecttypes/api/v2/views.py b/src/objecttypes/api/v2/views.py index 12849517..ad35a102 100644 --- a/src/objecttypes/api/v2/views.py +++ b/src/objecttypes/api/v2/views.py @@ -42,8 +42,30 @@ def perform_destroy(self, instance): @extend_schema_view( - retrieve=extend_schema(operation_id="objectversion_read"), - destroy=extend_schema(operation_id="objectversion_delete"), + retrieve=extend_schema( + operation_id="objectversion_read", + description=_("Retrieve an OBJECTTYPE with the given version."), + ), + list=extend_schema( + operation_id="objectversion_list", + description=_("Retrieve all versions of an OBJECTTYPE"), + ), + create=extend_schema( + operation_id="objectversion_create", + description=_("Create an OBJECTTYPE with the given version."), + ), + destroy=extend_schema( + operation_id="objectversion_delete", + description=_("Destroy the given OBJECTTYPE."), + ), + update=extend_schema( + operation_id="objectversion_update", + description=_("Update an OBJECTTYPE with the given version."), + ), + partial_update=extend_schema( + operation_id="objectversion_partial_update", + description=_("Partially update an OBJECTTYPE with the given version."), + ), ) class ObjectVersionViewSet(NestedViewSetMixin, viewsets.ModelViewSet): queryset = ObjectVersion.objects.order_by("object_type", "-version")