Skip to content

Commit

Permalink
[#513] Release 3.0.0 (#149)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Sonny Bakker <[email protected]>
  • Loading branch information
SonnyBA and Sonny Bakker authored Jan 22, 2025
1 parent 881ea76 commit 46640c0
Show file tree
Hide file tree
Showing 9 changed files with 133 additions and 42 deletions.
6 changes: 5 additions & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -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}",
Expand Down
47 changes: 47 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config_cli.html>`_
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)
------------------

Expand Down
40 changes: 23 additions & 17 deletions README.NL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -31,22 +31,28 @@ API specificatie

|lint-oas| |generate-sdks| |generate-postman-collection|

============== ============== =============================
Versie Release datum API specificatie
============== ============== =============================
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.2.2..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.2.2 2022-08-23 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.2.0..2.2.2#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.2.0 2022-06-24 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.0.0..2.2.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.0.0 2021-10-04 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/1.2.0..2.0.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
============== ============== =============================
================= ============== =============================
Applicatie versie Release datum API specificatie
================= ============== =============================
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/3.0.0..master>`_)
3.0.0 2025-01-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.0/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.3.0..3.0.0>`_)
2.3.0 2025-01-10 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.3.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.3.0/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.2.2..2.3.0>`_)
2.2.2 2022-08-23 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.2.0..2.2.2#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.2.0 2022-06-24 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/2.0.0..2.2.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.0.0 2021-10-04 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/1.2.0..2.0.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
================= ============== =============================

Vorige versies worden nog 6 maanden ondersteund nadat de volgende versie is uitgebracht.

Expand Down
40 changes: 23 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -30,22 +30,28 @@ API specification

|lint-oas| |generate-sdks| |generate-postman-collection|

============== ============== =============================
Version Release date API specification
============== ============== =============================
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.2.2..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.2.2 2022-08-23 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.2.0..2.2.2#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.2.0 2022-06-24 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.0.0..2.2.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.0.0 2021-10-04 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/1.2.0..2.0.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
============== ============== =============================
=================== ============== =============================
Application version Release date API specification
=================== ============== =============================
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/src/objecttypes/api/v2/openapi.yaml>`_,
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/3.0.0..master>`_)
3.0.0 2025-01-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.0/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.3.0..3.0.0>`_)
2.3.0 2025-01-10 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.3.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.3.0/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.2.2..2.3.0>`_)
2.2.2 2022-08-23 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.2/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.2.0..2.2.2#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.2.0 2022-06-24 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.2.0/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/2.0.0..2.2.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
2.0.0 2021-10-04 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/2.0.0/src/objecttypes/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objecttypes-api/compare/1.2.0..2.0.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
=================== ============== =============================

Previous versions are supported for 6 month after the next version is released.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
4 changes: 2 additions & 2 deletions publiccode.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions src/objecttypes/api/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -292,6 +297,7 @@ paths:
description: OK
delete:
operationId: objectversion_delete
description: Destroy the given OBJECTTYPE.
parameters:
- in: path
name: objecttype_uuid
Expand Down
26 changes: 24 additions & 2 deletions src/objecttypes/api/v2/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 46640c0

Please sign in to comment.