From c64e8cf7c16c6a210b5e8c3917b5391501f85ad4 Mon Sep 17 00:00:00 2001 From: Anna Shamray <47745906+annashamray@users.noreply.github.com> Date: Tue, 1 Oct 2024 17:25:43 +0200 Subject: [PATCH 01/15] Merge pull request #462 from maykinmedia/release/2.4.4 Release/2.4.4 --- .bumpversion.cfg | 2 +- CHANGELOG.rst | 24 +++++++++++++++++++----- README.NL.rst | 10 +++++----- README.rst | 10 +++++----- docs/api/index.rst | 6 +++--- package-lock.json | 4 ++-- package.json | 2 +- publiccode.yaml | 2 +- requirements/base.txt | 6 ++++-- requirements/ci.txt | 3 ++- requirements/dev.txt | 3 ++- src/objects/__init__.py | 2 +- src/objects/api/v2/openapi.yaml | 2 +- src/objects/conf/api.py | 3 ++- 14 files changed, 49 insertions(+), 30 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index f2c8fe93..b2f6deac 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,7 +1,7 @@ [bumpversion] commit = False tag = False -current_version = 2.4.3 +current_version = 2.4.4 [bumpversion:file:README.rst] diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 75f8ca93..fb35d940 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,13 +2,27 @@ Change history ============== -2.x.x -===== -*TBD* +3.0.0 (WIP) +----------- -**New features** +**Breaking changes** + +* dropped support for v1 endpoints (#453) + + +2.4.4 (2024-10-01) +------------------ + +**Bugfixes and QOL** + +* fixed CSP errors on the OAS page (#458) +* fixed OIDC login by making SameSite setting lax (#458) +* fixed adding permissions in the Admin (#449) +* fixed ``NOTIFICATIONS_DISABLED`` setting (#452) + +**Project maintenance** -* Updated OAF version to 0.9.0. This upgrade allows admin users managing their sessions through the admin. +* added CI action to check if OAF is up-to-date (#443) 2.4.3 (2024-09-18) diff --git a/README.NL.rst b/README.NL.rst index ffffeb58..f8aad691 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -2,7 +2,7 @@ Objecten API ============ -:Version: 2.4.3 +:Version: 2.4.4 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objecten, assets, zaakobjecten @@ -38,10 +38,10 @@ Versie Release datum API specificatie ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`verschillen `_) -2.4.3 2024-03-22 `ReDoc `_, - `Swagger `_ - (`verschillen `_) + (`verschillen `_) +2.4.4 2024-03-22 `ReDoc `_, + `Swagger `_ + (`verschillen `_) 2.3.0 2024-03-15 `ReDoc `_, `Swagger `_ (`verschillen `_) diff --git a/README.rst b/README.rst index 85b2e75f..ac1664ee 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Objects API =========== -:Version: 2.4.3 +:Version: 2.4.4 :Source: https://github.com/maykinmedia/objects-api :Keywords: objects, assets, zaakobjecten @@ -36,10 +36,10 @@ Version Release date API specification ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`diff `_) -2.4.3 2024-03-22 `ReDoc `_, - `Swagger `_ - (`diff `_) + (`diff `_) +2.4.4 2024-03-22 `ReDoc `_, + `Swagger `_ + (`diff `_) 2.3.0 2024-03-15 `ReDoc `_, `Swagger `_ (`diff `_) diff --git a/docs/api/index.rst b/docs/api/index.rst index 81112203..1e398557 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -14,9 +14,9 @@ API Specification version(s) `Redoc `__, `Swagger `__ ) -`Objects API`_ 2.4.3 ( - `Redoc `__, - `Swagger `__ +`Objects API`_ 2.4.4 ( + `Redoc `__, + `Swagger `__ ) ====================== ========================================== diff --git a/package-lock.json b/package-lock.json index bcb89ee0..f7e0795c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "objects", - "version": "2.4.3", + "version": "2.4.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "objects", - "version": "2.4.3", + "version": "2.4.4", "license": "UNLICENSED", "dependencies": { "microscope-sass": "latest", diff --git a/package.json b/package.json index 622f4bcd..22f4ddc7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "objects", - "version": "2.4.3", + "version": "2.4.4", "description": "objects project", "main": "src/objects/static/bundles/objects-js.js", "directories": { diff --git a/publiccode.yaml b/publiccode.yaml index d2e4d661..78f4ed23 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -7,7 +7,7 @@ publiccodeYmlVersion: '0.2' name: Objects API url: 'http://github.com/maykinmedia/objects-api.git' softwareType: standalone/backend -softwareVersion: 2.4.3 +softwareVersion: 2.4.4 releaseDate: '2021-01-13' logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png' platforms: diff --git a/requirements/base.txt b/requirements/base.txt index d4b708e9..aaccbebf 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -187,8 +187,10 @@ djangorestframework-inclusions==1.2.0 # via open-api-framework drf-nested-routers==0.94.1 # via commonground-api-common -drf-spectacular==0.27.2 - # via open-api-framework +drf-spectacular[sidecar]==0.27.2 + # via + # drf-spectacular + # open-api-framework drf-spectacular-sidecar==2024.7.1 # via drf-spectacular drf-yasg==1.21.7 diff --git a/requirements/ci.txt b/requirements/ci.txt index 31e03ed4..e122cefb 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -348,10 +348,11 @@ drf-nested-routers==0.94.1 # -c requirements/base.txt # -r requirements/base.txt # commonground-api-common -drf-spectacular==0.27.2 +drf-spectacular[sidecar]==0.27.2 # via # -c requirements/base.txt # -r requirements/base.txt + # drf-spectacular # open-api-framework drf-spectacular-sidecar==2024.7.1 # via diff --git a/requirements/dev.txt b/requirements/dev.txt index de9a8938..3a931e2a 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -385,10 +385,11 @@ drf-nested-routers==0.94.1 # -c requirements/ci.txt # -r requirements/ci.txt # commonground-api-common -drf-spectacular==0.27.2 +drf-spectacular[sidecar]==0.27.2 # via # -c requirements/ci.txt # -r requirements/ci.txt + # drf-spectacular # open-api-framework drf-spectacular-sidecar==2024.7.1 # via diff --git a/src/objects/__init__.py b/src/objects/__init__.py index 5f18cdd4..0ba1c8ff 100644 --- a/src/objects/__init__.py +++ b/src/objects/__init__.py @@ -1,6 +1,6 @@ from .celery import app as celery_app __all__ = ("celery_app",) -__version__ = "2.4.3" +__version__ = "2.4.4" __author__ = "Maykin Media" __homepage__ = "https://github.com/maykinmedia/objects-api" diff --git a/src/objects/api/v2/openapi.yaml b/src/objects/api/v2/openapi.yaml index 7fa40c26..64c57829 100644 --- a/src/objects/api/v2/openapi.yaml +++ b/src/objects/api/v2/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Objects API - version: 2.4.3 + version: 2.4.4 (v2) description: | An API to manage Objects. diff --git a/src/objects/conf/api.py b/src/objects/conf/api.py index 5575c3ed..f0a1dc99 100644 --- a/src/objects/conf/api.py +++ b/src/objects/conf/api.py @@ -1,4 +1,5 @@ -API_VERSION = "2.4.3" +API_VERSION = "2.4.4" +VERSIONS = {"v1": "1.3.0", "v2": "2.4.4"} # api settings REST_FRAMEWORK = { From e73a0f4682d90d040b7f5e5c2a2bd27eb3b6d4d8 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 8 Jan 2025 10:52:14 +0100 Subject: [PATCH 02/15] [#513] Update changelog & README --- CHANGELOG.rst | 62 +++++++++++++++++++++++++++++++++++++++++++++++---- README.rst | 10 +++++++-- 2 files changed, 66 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index fb35d940..93b2c26c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,13 +2,68 @@ Change history ============== -3.0.0 (WIP) ------------ +2.5.0 (2025-01-09) +------------------ **Breaking changes** -* dropped support for v1 endpoints (#453) +* 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``. + Note that not all previous configurable options are available in this release. + +* added support for configuring permissions through ``django-setup-configuration`` + version ``0.4.0`` [#497] +* added support for configuring token authorizations through ``django-setup-configuration`` + version ``0.4.0`` [#485] +* added support for configuring ``mozilla-django-oidc-db`` through ``django-setup-configuration`` + version ``0.4.0`` [#490] +* added support for configuring ``OBJECTTYPE``'s through ``django-setup-configuration`` + version ``0.4.0`` [#467] +* added support for configuring Notificatiescomponentconfiguratie through ``django-setup-configuration`` + version ``0.4.0`` [#484] +* added the new ``data_attrs`` query parameter for the ``OBJECT``'s resource [#472] + +.. warning:: + Usage of the `data_attr` query parameter is deprecated. Usage of the + new `data_attrs` query parameter is recommended. + +* 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] +* fixed documentation building in CI [#501] +* included ``gettext`` in docker images [#495] +* 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. + +* updated PATCH request behaviour for the ``data`` field [#466] +* fixed CSP errors [open-api-framework/#68] + +**Project maintenance** + +* implementend CI action to create a PR with latest OAF version [open-api-framework/#44] +* security updates [open-api-framework/#93] +* switched from ``pip-compile`` to ``uv`` [open-api-framework/#81] +* pinned ``publish`` workflow to ``v3.0.1`` [#504] +* implementend open-api-workflows [open-api-framework/#13] + +** Documentation** + +* added documentation for notification retry behavior [#403] +* added missing changelog entry [#455] 2.4.4 (2024-10-01) ------------------ @@ -24,7 +79,6 @@ Change history * added CI action to check if OAF is up-to-date (#443) - 2.4.3 (2024-09-18) ------------------ diff --git a/README.rst b/README.rst index ac1664ee..215c33e8 100644 --- a/README.rst +++ b/README.rst @@ -36,10 +36,16 @@ Version Release date API specification ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`diff `_) + (`diff `_) +2.5.0 2025-01-08 `ReDoc `_, + `Swagger `_ + (`diff `_) 2.4.4 2024-03-22 `ReDoc `_, `Swagger `_ - (`diff `_) + (`diff `_) +2.4.3 2024-03-22 `ReDoc `_, + `Swagger `_ + (`diff `_) 2.3.0 2024-03-15 `ReDoc `_, `Swagger `_ (`diff `_) From 547c07e8669f3509ff0d3ac82af7088d166d45d3 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 8 Jan 2025 10:58:32 +0100 Subject: [PATCH 03/15] [#513] bump version for various files --- .bumpversion.cfg | 2 +- README.NL.rst | 12 +++++++++--- README.rst | 2 +- docs/api/index.rst | 12 ++++++------ package-lock.json | 4 ++-- package.json | 2 +- publiccode.yaml | 2 +- src/objects/__init__.py | 2 +- src/objects/api/v2/openapi.yaml | 2 +- src/objects/conf/api.py | 4 ++-- 10 files changed, 25 insertions(+), 19 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index b2f6deac..f09e2f58 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,7 +1,7 @@ [bumpversion] commit = False tag = False -current_version = 2.4.4 +current_version = 2.5.0 [bumpversion:file:README.rst] diff --git a/README.NL.rst b/README.NL.rst index f8aad691..50d714f2 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -2,7 +2,7 @@ Objecten API ============ -:Version: 2.4.4 +:Version: 2.5.0 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objecten, assets, zaakobjecten @@ -38,10 +38,16 @@ Versie Release datum API specificatie ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`verschillen `_) + (`verschillen `_) +2.5.0 2025-01-08 `ReDoc `_, + `Swagger `_ + (`diff `_) 2.4.4 2024-03-22 `ReDoc `_, `Swagger `_ - (`verschillen `_) + (`verschillen `_) +2.4.3 2024-03-22 `ReDoc `_, + `Swagger `_ + (`verschillen `_) 2.3.0 2024-03-15 `ReDoc `_, `Swagger `_ (`verschillen `_) diff --git a/README.rst b/README.rst index 215c33e8..0e42d6f4 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Objects API =========== -:Version: 2.4.4 +:Version: 2.5.0 :Source: https://github.com/maykinmedia/objects-api :Keywords: objects, assets, zaakobjecten diff --git a/docs/api/index.rst b/docs/api/index.rst index 1e398557..a61a0bcf 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -10,13 +10,13 @@ as of March 1, 2022`_. Their specifications can be found below. ====================== ========================================== API Specification version(s) ====================== ========================================== -`Objecttypes API`_ 2.0.0 ( - `Redoc `__, - `Swagger `__ +`Objecttypes API`_ 2.2.2 ( + `Redoc `__, + `Swagger `__ ) -`Objects API`_ 2.4.4 ( - `Redoc `__, - `Swagger `__ +`Objects API`_ 2.5.0 ( + `Redoc `__, + `Swagger `__ ) ====================== ========================================== diff --git a/package-lock.json b/package-lock.json index f7e0795c..5afa0086 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "objects", - "version": "2.4.4", + "version": "2.5.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "objects", - "version": "2.4.4", + "version": "2.5.0", "license": "UNLICENSED", "dependencies": { "microscope-sass": "latest", diff --git a/package.json b/package.json index 22f4ddc7..41190f60 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "objects", - "version": "2.4.4", + "version": "2.5.0", "description": "objects project", "main": "src/objects/static/bundles/objects-js.js", "directories": { diff --git a/publiccode.yaml b/publiccode.yaml index 78f4ed23..3d6827a6 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -7,7 +7,7 @@ publiccodeYmlVersion: '0.2' name: Objects API url: 'http://github.com/maykinmedia/objects-api.git' softwareType: standalone/backend -softwareVersion: 2.4.4 +softwareVersion: 2.5.0 releaseDate: '2021-01-13' logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png' platforms: diff --git a/src/objects/__init__.py b/src/objects/__init__.py index 0ba1c8ff..f9b732ce 100644 --- a/src/objects/__init__.py +++ b/src/objects/__init__.py @@ -1,6 +1,6 @@ from .celery import app as celery_app __all__ = ("celery_app",) -__version__ = "2.4.4" +__version__ = "2.5.0" __author__ = "Maykin Media" __homepage__ = "https://github.com/maykinmedia/objects-api" diff --git a/src/objects/api/v2/openapi.yaml b/src/objects/api/v2/openapi.yaml index 64c57829..5736214a 100644 --- a/src/objects/api/v2/openapi.yaml +++ b/src/objects/api/v2/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Objects API - version: 2.4.4 (v2) + version: 2.5.0 description: | An API to manage Objects. diff --git a/src/objects/conf/api.py b/src/objects/conf/api.py index f0a1dc99..52e9baca 100644 --- a/src/objects/conf/api.py +++ b/src/objects/conf/api.py @@ -1,5 +1,5 @@ -API_VERSION = "2.4.4" -VERSIONS = {"v1": "1.3.0", "v2": "2.4.4"} +API_VERSION = "2.5.0" +VERSIONS = {"v1": "1.3.0", "v2": "2.5.0"} # api settings REST_FRAMEWORK = { From faec711d3f6f225cf12146b13f4871c6e6c87779 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Thu, 9 Jan 2025 16:18:18 +0100 Subject: [PATCH 04/15] [#513] update CHANGELOG & bump version for various files --- CHANGELOG.rst | 7 +++++++ README.NL.rst | 9 ++++++--- README.rst | 9 ++++++--- docs/api/index.rst | 6 +++--- package.json | 2 +- publiccode.yaml | 4 ++-- src/objects/__init__.py | 2 +- src/objects/conf/api.py | 4 ++-- 8 files changed, 28 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 93b2c26c..da7bd2fb 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,13 @@ Change history ============== +3.0.0 (2025-01-09) +------------------ + +**Breaking changes** + +* removed objects-api V1 [#453] + 2.5.0 (2025-01-09) ------------------ diff --git a/README.NL.rst b/README.NL.rst index 50d714f2..b002632e 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -2,7 +2,7 @@ Objecten API ============ -:Version: 2.5.0 +:Version: 3.0.0 :Source: https://github.com/maykinmedia/objecttypes-api :Keywords: objecten, assets, zaakobjecten @@ -38,8 +38,11 @@ Versie Release datum API specificatie ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`verschillen `_) -2.5.0 2025-01-08 `ReDoc `_, + (`verschillen `_) +3.0.0 2025-01-09 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.5.0 2025-01-09 `ReDoc `_, `Swagger `_ (`diff `_) 2.4.4 2024-03-22 `ReDoc `_, diff --git a/README.rst b/README.rst index 0e42d6f4..843a8422 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Objects API =========== -:Version: 2.5.0 +:Version: 3.0.0 :Source: https://github.com/maykinmedia/objects-api :Keywords: objects, assets, zaakobjecten @@ -36,8 +36,11 @@ Version Release date API specification ============== ============== ============================= latest n/a `ReDoc `_, `Swagger `_, - (`diff `_) -2.5.0 2025-01-08 `ReDoc `_, + (`diff `_) +3.0.0 2025-01-09 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.5.0 2025-01-09 `ReDoc `_, `Swagger `_ (`diff `_) 2.4.4 2024-03-22 `ReDoc `_, diff --git a/docs/api/index.rst b/docs/api/index.rst index a61a0bcf..0dc2a067 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -14,9 +14,9 @@ API Specification version(s) `Redoc `__, `Swagger `__ ) -`Objects API`_ 2.5.0 ( - `Redoc `__, - `Swagger `__ +`Objects API`_ 3.0.0 ( + `Redoc `__, + `Swagger `__ ) ====================== ========================================== diff --git a/package.json b/package.json index 41190f60..afd647db 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "objects", - "version": "2.5.0", + "version": "3.0.0", "description": "objects project", "main": "src/objects/static/bundles/objects-js.js", "directories": { diff --git a/publiccode.yaml b/publiccode.yaml index 3d6827a6..099b3b04 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -7,8 +7,8 @@ publiccodeYmlVersion: '0.2' name: Objects API url: 'http://github.com/maykinmedia/objects-api.git' softwareType: standalone/backend -softwareVersion: 2.5.0 -releaseDate: '2021-01-13' +softwareVersion: 3.0.0 +releaseDate: '2025-01-09' logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png' platforms: - web diff --git a/src/objects/__init__.py b/src/objects/__init__.py index f9b732ce..9a611bc0 100644 --- a/src/objects/__init__.py +++ b/src/objects/__init__.py @@ -1,6 +1,6 @@ from .celery import app as celery_app __all__ = ("celery_app",) -__version__ = "2.5.0" +__version__ = "3.0.0" __author__ = "Maykin Media" __homepage__ = "https://github.com/maykinmedia/objects-api" diff --git a/src/objects/conf/api.py b/src/objects/conf/api.py index 52e9baca..7038b569 100644 --- a/src/objects/conf/api.py +++ b/src/objects/conf/api.py @@ -1,5 +1,5 @@ -API_VERSION = "2.5.0" -VERSIONS = {"v1": "1.3.0", "v2": "2.5.0"} +API_VERSION = "3.0.0" +VERSIONS = {"v1": "1.3.0", "v2": "3.0.0"} # api settings REST_FRAMEWORK = { From 549d1688fb680d2be6a1748116b5cf3a919486f7 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Thu, 9 Jan 2025 16:19:30 +0100 Subject: [PATCH 05/15] [#513] use more fine-grained search & replace for README's --- .bumpversion.cfg | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index f09e2f58..62e6a2fa 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,11 +1,15 @@ [bumpversion] commit = False tag = False -current_version = 2.5.0 +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}", From 2068f109863c94a6003767e37325938870739dbd Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Thu, 9 Jan 2025 16:22:04 +0100 Subject: [PATCH 06/15] [#513] undo requirements changes --- requirements/base.txt | 6 ++---- requirements/ci.txt | 3 +-- requirements/dev.txt | 3 +-- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index aaccbebf..d4b708e9 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -187,10 +187,8 @@ djangorestframework-inclusions==1.2.0 # via open-api-framework drf-nested-routers==0.94.1 # via commonground-api-common -drf-spectacular[sidecar]==0.27.2 - # via - # drf-spectacular - # open-api-framework +drf-spectacular==0.27.2 + # via open-api-framework drf-spectacular-sidecar==2024.7.1 # via drf-spectacular drf-yasg==1.21.7 diff --git a/requirements/ci.txt b/requirements/ci.txt index e122cefb..31e03ed4 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -348,11 +348,10 @@ drf-nested-routers==0.94.1 # -c requirements/base.txt # -r requirements/base.txt # commonground-api-common -drf-spectacular[sidecar]==0.27.2 +drf-spectacular==0.27.2 # via # -c requirements/base.txt # -r requirements/base.txt - # drf-spectacular # open-api-framework drf-spectacular-sidecar==2024.7.1 # via diff --git a/requirements/dev.txt b/requirements/dev.txt index 3a931e2a..de9a8938 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -385,11 +385,10 @@ drf-nested-routers==0.94.1 # -c requirements/ci.txt # -r requirements/ci.txt # commonground-api-common -drf-spectacular[sidecar]==0.27.2 +drf-spectacular==0.27.2 # via # -c requirements/ci.txt # -r requirements/ci.txt - # drf-spectacular # open-api-framework drf-spectacular-sidecar==2024.7.1 # via From 00291d3b470077d5d88c631de0bfec463e24aaec Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Thu, 9 Jan 2025 16:22:30 +0100 Subject: [PATCH 07/15] [#513] remove previously `VERSIONS` setting --- src/objects/conf/api.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/objects/conf/api.py b/src/objects/conf/api.py index 7038b569..98e4bcb8 100644 --- a/src/objects/conf/api.py +++ b/src/objects/conf/api.py @@ -1,5 +1,4 @@ API_VERSION = "3.0.0" -VERSIONS = {"v1": "1.3.0", "v2": "3.0.0"} # api settings REST_FRAMEWORK = { From adc75191dc9000d9f9a45978c8344fb6fd472e99 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Thu, 9 Jan 2025 16:24:07 +0100 Subject: [PATCH 08/15] [#513] regenerate openapi spec --- src/objects/api/v2/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/objects/api/v2/openapi.yaml b/src/objects/api/v2/openapi.yaml index 5736214a..09c3cac6 100644 --- a/src/objects/api/v2/openapi.yaml +++ b/src/objects/api/v2/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Objects API - version: 2.5.0 + version: 3.0.0 description: | An API to manage Objects. From 521701458feaeb7ff60103ef395437716f6bdfbb Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Thu, 9 Jan 2025 17:30:29 +0100 Subject: [PATCH 09/15] [#513] moved django-setup-configuration upgrade to breaking changes --- CHANGELOG.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index da7bd2fb..03e86227 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -33,6 +33,9 @@ Change history version ``0.4.0`` [#467] * added support for configuring Notificatiescomponentconfiguratie through ``django-setup-configuration`` version ``0.4.0`` [#484] + +**New features** + * added the new ``data_attrs`` query parameter for the ``OBJECT``'s resource [#472] .. warning:: @@ -42,6 +45,7 @@ Change history * 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] From 871319c0588399066ab05c681257a38bcb9b6d82 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Fri, 10 Jan 2025 12:32:41 +0100 Subject: [PATCH 10/15] [#513] update warning message --- CHANGELOG.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 03e86227..37709bca 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -21,7 +21,6 @@ Change history 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``. - Note that not all previous configurable options are available in this release. * added support for configuring permissions through ``django-setup-configuration`` version ``0.4.0`` [#497] From c0418bc95e77cd04d94ac16e3eba9a5b38dd7f58 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Mon, 13 Jan 2025 16:33:21 +0100 Subject: [PATCH 11/15] [#513] update version number & release date --- CHANGELOG.rst | 4 ++-- README.NL.rst | 6 +++--- README.rst | 2 +- package-lock.json | 4 ++-- publiccode.yaml | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 37709bca..42660383 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,7 +2,7 @@ Change history ============== -3.0.0 (2025-01-09) +3.0.0 (2025-01-14) ------------------ **Breaking changes** @@ -70,7 +70,7 @@ Change history * pinned ``publish`` workflow to ``v3.0.1`` [#504] * implementend open-api-workflows [open-api-framework/#13] -** Documentation** +**Documentation** * added documentation for notification retry behavior [#403] * added missing changelog entry [#455] diff --git a/README.NL.rst b/README.NL.rst index b002632e..736b7b2c 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -39,12 +39,12 @@ Versie Release datum API specificatie latest n/a `ReDoc `_, `Swagger `_, (`verschillen `_) -3.0.0 2025-01-09 `ReDoc `_, +3.0.0 2025-01-14 `ReDoc `_, `Swagger `_ - (`diff `_) + (`verschillen `_) 2.5.0 2025-01-09 `ReDoc `_, `Swagger `_ - (`diff `_) + (`verschillen `_) 2.4.4 2024-03-22 `ReDoc `_, `Swagger `_ (`verschillen `_) diff --git a/README.rst b/README.rst index 843a8422..5b9b79aa 100644 --- a/README.rst +++ b/README.rst @@ -37,7 +37,7 @@ Version Release date API specification latest n/a `ReDoc `_, `Swagger `_, (`diff `_) -3.0.0 2025-01-09 `ReDoc `_, +3.0.0 2025-01-14 `ReDoc `_, `Swagger `_ (`diff `_) 2.5.0 2025-01-09 `ReDoc `_, diff --git a/package-lock.json b/package-lock.json index 5afa0086..3236112f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "objects", - "version": "2.5.0", + "version": "3.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "objects", - "version": "2.5.0", + "version": "3.0.0", "license": "UNLICENSED", "dependencies": { "microscope-sass": "latest", diff --git a/publiccode.yaml b/publiccode.yaml index 099b3b04..8dee8fbd 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -8,7 +8,7 @@ name: Objects API url: 'http://github.com/maykinmedia/objects-api.git' softwareType: standalone/backend softwareVersion: 3.0.0 -releaseDate: '2025-01-09' +releaseDate: '2025-01-14' logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png' platforms: - web From 6648037081114360379ea02dbb4ee168697fd86b Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Mon, 13 Jan 2025 16:36:07 +0100 Subject: [PATCH 12/15] [#513] use previous API specification version --- src/objects/api/v2/openapi.yaml | 2 +- src/objects/conf/api.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/objects/api/v2/openapi.yaml b/src/objects/api/v2/openapi.yaml index 09c3cac6..7fa40c26 100644 --- a/src/objects/api/v2/openapi.yaml +++ b/src/objects/api/v2/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Objects API - version: 3.0.0 + version: 2.4.3 description: | An API to manage Objects. diff --git a/src/objects/conf/api.py b/src/objects/conf/api.py index 98e4bcb8..5575c3ed 100644 --- a/src/objects/conf/api.py +++ b/src/objects/conf/api.py @@ -1,4 +1,4 @@ -API_VERSION = "3.0.0" +API_VERSION = "2.4.3" # api settings REST_FRAMEWORK = { From 5aaf7affb2001fda1e5d419e555d118002aa9ef4 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Mon, 13 Jan 2025 16:38:15 +0100 Subject: [PATCH 13/15] [#513] revert changes to link for API version --- docs/api/index.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/index.rst b/docs/api/index.rst index 0dc2a067..81112203 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -10,13 +10,13 @@ as of March 1, 2022`_. Their specifications can be found below. ====================== ========================================== API Specification version(s) ====================== ========================================== -`Objecttypes API`_ 2.2.2 ( - `Redoc `__, - `Swagger `__ +`Objecttypes API`_ 2.0.0 ( + `Redoc `__, + `Swagger `__ ) -`Objects API`_ 3.0.0 ( - `Redoc `__, - `Swagger `__ +`Objects API`_ 2.4.3 ( + `Redoc `__, + `Swagger `__ ) ====================== ========================================== From 3d8e97977f061fc5a82459a05c0693004f78bd55 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 22 Jan 2025 11:20:50 +0100 Subject: [PATCH 14/15] [#513] update release date & add more descriptive version column --- CHANGELOG.rst | 2 +- README.NL.rst | 68 ++++++++++++++++++++++++------------------------- README.rst | 68 ++++++++++++++++++++++++------------------------- publiccode.yaml | 2 +- 4 files changed, 70 insertions(+), 70 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 42660383..9c76ab37 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,7 +2,7 @@ Change history ============== -3.0.0 (2025-01-14) +3.0.0 (2025-01-22) ------------------ **Breaking changes** diff --git a/README.NL.rst b/README.NL.rst index 736b7b2c..111c49eb 100644 --- a/README.NL.rst +++ b/README.NL.rst @@ -33,40 +33,40 @@ API specificatie |lint-oas| |generate-sdks| |generate-postman-collection| -============== ============== ============================= -Versie Release datum API specificatie -============== ============== ============================= -latest n/a `ReDoc `_, - `Swagger `_, - (`verschillen `_) -3.0.0 2025-01-14 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.5.0 2025-01-09 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.4.4 2024-03-22 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.4.3 2024-03-22 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.3.0 2024-03-15 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.2.1 2024-01-30 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.1.0 2022-06-24 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.1.0 2022-05-17 `ReDoc `_, - `Swagger `_ - (`verschillen `_) -2.0.0 2021-09-22 `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.5.0 2025-01-09 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.4.4 2024-03-22 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.4.3 2024-03-22 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.3.0 2024-03-15 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.2.1 2024-01-30 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.1.0 2022-06-24 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.1.0 2022-05-17 `ReDoc `_, + `Swagger `_ + (`verschillen `_) +2.0.0 2021-09-22 `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 5b9b79aa..f6341404 100644 --- a/README.rst +++ b/README.rst @@ -31,40 +31,40 @@ API specification |lint-oas| |generate-sdks| |generate-postman-collection| -============== ============== ============================= -Version Release date API specification -============== ============== ============================= -latest n/a `ReDoc `_, - `Swagger `_, - (`diff `_) -3.0.0 2025-01-14 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.5.0 2025-01-09 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.4.4 2024-03-22 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.4.3 2024-03-22 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.3.0 2024-03-15 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.2.1 2024-01-30 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.1.1 2022-06-24 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.1.0 2022-05-17 `ReDoc `_, - `Swagger `_ - (`diff `_) -2.0.0 2021-09-22 `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.5.0 2025-01-09 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.4.4 2024-03-22 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.4.3 2024-03-22 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.3.0 2024-03-15 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.2.1 2024-01-30 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.1.1 2022-06-24 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.1.0 2022-05-17 `ReDoc `_, + `Swagger `_ + (`diff `_) +2.0.0 2021-09-22 `ReDoc `_, + `Swagger `_ + (`diff `_) +=================== ============== ============================= Previous versions are supported for 6 month after the next version is released. diff --git a/publiccode.yaml b/publiccode.yaml index 8dee8fbd..03898258 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -8,7 +8,7 @@ name: Objects API url: 'http://github.com/maykinmedia/objects-api.git' softwareType: standalone/backend softwareVersion: 3.0.0 -releaseDate: '2025-01-14' +releaseDate: '2025-01-22' logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png' platforms: - web From e343aa85a7c2fdc2551dd5e3d6956eb29d77074c Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Wed, 22 Jan 2025 11:23:53 +0100 Subject: [PATCH 15/15] [#513] Update specification version & use latest openapi spec for RTD links --- docs/api/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/index.rst b/docs/api/index.rst index 81112203..12694fae 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -10,13 +10,13 @@ as of March 1, 2022`_. Their specifications can be found below. ====================== ========================================== API Specification version(s) ====================== ========================================== -`Objecttypes API`_ 2.0.0 ( - `Redoc `__, - `Swagger `__ +`Objecttypes API`_ 2.2.2 ( + `Redoc `__, + `Swagger `__ ) `Objects API`_ 2.4.3 ( - `Redoc `__, - `Swagger `__ + `Redoc `__, + `Swagger `__ ) ====================== ==========================================