From 97e3ac1831b5ca41191794ce0587af0004d4107a Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 8 Jan 2025 11:48:17 +0100 Subject: [PATCH 1/3] [#513] update changelog & README --- CHANGELOG.rst | 32 ++++++++++++++++++++++++++++++++ README.NL.rst | 7 +++++-- README.rst | 7 +++++-- 3 files changed, 42 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 9ec19cc..ab19226 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,38 @@ Change history ============== +2.3.0 (2025-01-08) +------------------ + +**New features** + +* added support for configuring ``mozilla-django-oidc-db`` through ``django-setup-configuration`` + version ``0.4.0`` [objects-api/#480] +* added support for configuring token authorizations through ``django-setup-configuration`` + version ``0.4.0`` [objects-api/#485] + +**Bugfixes and QOL** + +* fixed ``latest`` docker image tag not being pushed [open-api-framework/#92] +* updated ``django-setup-configuration`` to ``0.5.0`` and ``open-api-framework`` to ``0.9.1`` +* 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. + +* removed V1 endpoints [objects-api/#453] +* re-enabled Trivy image scanning [#463] + +**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 64d70bf..def3ce9 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -2,7 +2,7 @@ Objecttypen API =============== -:Version: 2.2.2 +:Version: 2.3.0 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objecten, assets, zaakobjecten @@ -36,7 +36,10 @@ Versie Release datum API specificatie ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`verschillen `_) + (`verschillen `_) +2.3.0 2025-01-08 `ReDoc `_, + `Swagger `_ + (`verschillen `_) 2.2.2 2022-08-23 `ReDoc `_, `Swagger `_ (`verschillen `_) diff --git a/README.rst b/README.rst index 79ef3ba..d3dd36a 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Objecttypes API =============== -:Version: 2.2.2 +:Version: 2.3.0 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objects, assets, zaakobjecten @@ -35,7 +35,10 @@ Version Release date API specification ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`diff `_) + (`diff `_) +2.3.0 2025-01-08 `ReDoc `_, + `Swagger `_ + (`diff `_) 2.2.2 2022-08-23 `ReDoc `_, `Swagger `_ (`diff `_) From 98fffb39ea92bada39856bccb54b16855631cd68 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 8 Jan 2025 12:04:14 +0100 Subject: [PATCH 2/3] [#513] bump version for various files --- package.json | 2 +- publiccode.yaml | 4 ++-- src/objecttypes/api/v2/openapi.yaml | 2 +- src/objecttypes/conf/api.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 3872a90..b668e45 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "objecttypes", - "version": "2.2.2", + "version": "2.3.0", "description": "objecttypes project", "main": "src/objecttypes/static/bundles/objecttypes-js.js", "directories": { diff --git a/publiccode.yaml b/publiccode.yaml index 0877083..24d626e 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: 2.3.0 +releaseDate: '2025-01-8' 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 226ac23..4f060a3 100644 --- a/src/objecttypes/api/v2/openapi.yaml +++ b/src/objecttypes/api/v2/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Objecttypes API - version: 2.2.2 + version: 2.3.0 description: |+ An API to manage Object types. diff --git a/src/objecttypes/conf/api.py b/src/objecttypes/conf/api.py index b60726a..4778433 100644 --- a/src/objecttypes/conf/api.py +++ b/src/objecttypes/conf/api.py @@ -1,6 +1,6 @@ from vng_api_common.conf.api import * # noqa - imports white-listed -API_VERSION = "2.2.2" +API_VERSION = "2.3.0" # api settings From b750ca028759b183ec4cfeb061c6d79462d66992 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 8 Jan 2025 12:08:12 +0100 Subject: [PATCH 3/3] [#513] regenerate spec with latest requirements --- src/objecttypes/api/v2/openapi.yaml | 114 ++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) diff --git a/src/objecttypes/api/v2/openapi.yaml b/src/objecttypes/api/v2/openapi.yaml index 4f060a3..f1593bb 100644 --- a/src/objecttypes/api/v2/openapi.yaml +++ b/src/objecttypes/api/v2/openapi.yaml @@ -111,6 +111,25 @@ paths: /objecttypes/{objecttype_uuid}/versions: get: operationId: objectversion_list + description: |- + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default parameters: - in: path name: objecttype_uuid @@ -144,6 +163,25 @@ paths: description: OK post: operationId: objectversion_create + description: |- + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default parameters: - in: header name: Content-Type @@ -179,6 +217,25 @@ paths: /objecttypes/{objecttype_uuid}/versions/{version}: get: operationId: objectversion_read + description: |- + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default parameters: - in: path name: objecttype_uuid @@ -208,6 +265,25 @@ paths: description: OK put: operationId: objectversion_update + description: |- + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default parameters: - in: header name: Content-Type @@ -250,6 +326,25 @@ paths: description: OK patch: operationId: objectversion_partial_update + description: |- + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default parameters: - in: header name: Content-Type @@ -292,6 +387,25 @@ paths: description: OK delete: operationId: objectversion_delete + description: |- + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default parameters: - in: path name: objecttype_uuid