Skip to content

Commit 26996a4

Browse files
danielmursa-devdanielmursa-dev
committed
🔖 Release 3.5.0
1 parent 5667da1 commit 26996a4

File tree

11 files changed

+107
-56
lines changed

11 files changed

+107
-56
lines changed

‎CHANGELOG.rst‎

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
Change history
33
==============
44

5-
3.5.0 (TBD)
6-
-----------
5+
3.5.0 (2025-12-01)
6+
------------------
77

88
.. warning::
99

1010
Changes to format of ``setup_configuration`` data for OpenID connect
1111

12-
In this release, ``mozilla-django-oidc-db`` has been updated to version 1.1.0, which requires the new data format.
12+
In this release, ``mozilla-django-oidc-db`` has been updated to version 1.1.1, which requires the new data format.
1313
The old format is deprecated and will be removed in future releases.
1414

1515
The new configuration must be used, as it splits the previous solo model configuration into ``OIDCProvider`` and ``OIDCClient``
@@ -33,6 +33,62 @@ Change history
3333
For detailed configuration, see :ref:`Admin OIDC Configuration Step <ref_step_mozilla_django_oidc_db.setup_configuration.steps.AdminOIDCConfigurationStep>`.
3434
Make sure to check which fields are marked as ``DEPRECATED`` and replace them with the fields that are mentioned as replacements.
3535

36+
**New features**
37+
38+
* [:open-api-framework:`152`] Add OpenTelemetry (``OTel``) for collecting and exporting application metrics.
39+
40+
* Metrics now exposed include:
41+
42+
- HTTP request durations.
43+
- Number of active requests.
44+
- Number of users, logins, logouts, failed logins, and account lockouts.
45+
- **CRUD** operations for the ``/objects`` endpoint.
46+
47+
* All metrics are exported using the **OpenTelemetry standard**, enabling seamless integration with existing monitoring and visualization platforms.
48+
49+
.. note::
50+
51+
The OpenTelemetry SDK is **enabled by default**.
52+
53+
If you do not have an endpoint to send system telemetry to, update your deployment to **disable it** by setting the environment variable:
54+
55+
.. code-block:: bash
56+
57+
OTEL_SDK_DISABLED=true
58+
59+
If this is not done, warnings will be emitted to the container logs. The application will continue to function normally.
60+
61+
All available metrics and details can be found in the :ref:`Observability documentation <installation_observability_index>`.
62+
63+
* [:open-api-framework:`188`] Support ``CSV`` in the data dump script, see :ref:`scripts`
64+
* [:objects-api:`621`] Improve admin search bar for JSON data using key-value patterns, see :ref:`admin_objects_search`
65+
66+
**Bugfixes**
67+
68+
* [:commonground-api-common:`134`] Fix exceptions in API endpoints not forwarded to Sentry when ``DEBUG=False``
69+
70+
**Maintenance**
71+
72+
* [:open-api-framework:`191`] ``nodejs`` to v24
73+
* [:open-api-workflows:`31`] ``codeql`` to v4
74+
* [:open-api-framework:`188`] Update docker backend image to ``python:3.12-slim-trixie`` and frontend image to ``node:24-trixie-slim``
75+
* Upgrade python dependencies
76+
77+
* [:open-api-framework:`171`] ``open-api-framework`` to 0.13.2
78+
* ``commonground-api-common`` to 2.10.5
79+
* ``notifications-api-common`` to 0.9.0
80+
* ``django-setup-configuration`` to 0.11.0
81+
* ``mozilla-django-oidc-db`` to 1.1.1
82+
* ``maykin-common`` to 0.11.0
83+
* ``django`` to 5.2.8
84+
* ``uwsgi`` to 2.0.31
85+
* ``pip`` to 25.3
86+
87+
**Documentation**
88+
89+
* [:objects-api:`689`] Fix resource reference in notification documentation.
90+
* [:objects-api:`694`] Add minimum postgres database requirements to documentation.
91+
3692

3793
3.4.0 (2025-10-28)
3894
------------------
@@ -61,7 +117,7 @@ Change history
61117

62118
**Project maintenance**
63119

64-
* [:open-api-framework:`163`] Integrate django-common to make uses of shared views/templates
120+
* [:open-api-framework:`163`] Integrate ``maykin-common`` to make uses of shared views/templates
65121
* [:objects-api:`663`] Upload performance tests results to bencher
66122
* [:open-api-workflows:`30`] Run API Design Rules linter on OpenAPI specification in CI
67123

‎README.NL.rst‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Objecten API
33
============
44

5-
:Version: 3.4.0
5+
:Version: 3.5.0
66
:Source: https://github.com/maykinmedia/objecttypes-api
77
:Keywords: objecten, assets, zaakobjecten
88

@@ -38,7 +38,10 @@ Applicatie versie Release datum API specificatie
3838
================= ============== =============================
3939
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
4040
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
41-
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.4.0..master>`_)
41+
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.5.0..master>`_)
42+
3.5.0 2025-12-01 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.5.0/src/objects/api/v2/openapi.yaml>`_,
43+
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.5.0/src/objects/api/v2/openapi.yaml>`_
44+
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.4.0..3.5.0>`_)
4245
3.4.0 2025-10-28 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`_,
4346
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`_
4447
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.3.1..3.4.0>`_)

‎README.rst‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Objects API
33
===========
44

5-
:Version: 3.4.0
5+
:Version: 3.5.0
66
:Source: https://github.com/maykinmedia/objects-api
77
:Keywords: objects, assets, zaakobjecten
88

@@ -36,7 +36,10 @@ Application version Release date API specification
3636
=================== ============== =============================
3737
latest n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
3838
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
39-
(`diff <https://github.com/maykinmedia/objects-api/compare/3.4.0..master>`_)
39+
(`diff <https://github.com/maykinmedia/objects-api/compare/3.5.0..master>`_)
40+
3.5.0 2025-12-01 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.5.0/src/objects/api/v2/openapi.yaml>`_,
41+
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.5.0/src/objects/api/v2/openapi.yaml>`_
42+
(`diff <https://github.com/maykinmedia/objects-api/compare/3.4.0..3.5.0>`_)
4043
3.4.0 2025-10-28 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`_,
4144
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`_
4245
(`diff <https://github.com/maykinmedia/objects-api/compare/3.3.1..3.4.0>`_)

‎docs/admin/object.rst‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ corrected in the "Correction" field of the next record.
6565
In the Objects API you always see one record, which contains data of a certain time (by default
6666
the latest one). However in the admin interface you can see all the records created for the object.
6767

68+
.. _admin_objects_search:
6869

6970
Search objects in the admin
7071
---------------------------
@@ -77,22 +78,21 @@ You can search by **UUID** or inside object data using the format:
7778
7879
Operators:
7980

80-
- ``exact`` - exact match
81-
- ``icontains`` - case insensitive substring match
82-
- ``gt`` - greater than
83-
- ``gte`` - greater than or equal to
84-
- ``lt`` - less than
81+
- ``exact`` - exact match
82+
- ``icontains`` - case insensitive substring match
83+
- ``gt`` - greater than
84+
- ``gte`` - greater than or equal to
85+
- ``lt`` - less than
8586
- ``lte`` - less than or equal to
8687

8788
Examples:
8889

89-
- ``0233da1f-32c1-4e7d-9896-2eecc7d24288`` - searching directly by object UUID
90-
- ``id__exact__1``
91-
- ``naam__icontains__boom``
92-
- ``date__gt__2025-01-01``
93-
- ``date__gte__2025-06-15``
94-
- ``date__lt__2025-12-31``
95-
- ``date__lte__2025-06-15``
96-
- ``location__city__exact__Amsterdam``
90+
- ``0233da1f-32c1-4e7d-9896-2eecc7d24288`` - searching directly by object UUID
91+
- ``id__exact__1``
92+
- ``naam__icontains__boom``
93+
- ``date__gt__2025-01-01``
94+
- ``date__gte__2025-06-15``
95+
- ``date__lt__2025-12-31``
96+
- ``date__lte__2025-06-15``
97+
- ``location__city__exact__Amsterdam``
9798
- ``location__region__icontains__Noord``
98-

‎docs/api/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ API Specification version(s)
1515
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.3/src/objecttypes/api/v2/openapi.yaml>`__
1616
)
1717
`Objects API`_ 2.5.0 (
18-
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`__,
19-
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`__
18+
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.5.0/src/objects/api/v2/openapi.yaml>`__,
19+
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.5.0/src/objects/api/v2/openapi.yaml>`__
2020
)
2121
====================== ==========================================
2222

‎docs/conf.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,10 @@
119119

120120
extlinks = {
121121
"objects-api": ("https://github.com/maykinmedia/objects-api/issues/%s", "#%s"),
122+
"commonground-api-common": (
123+
"https://github.com/maykinmedia/commonground-api-common/issues/%s",
124+
"#%s",
125+
),
122126
"open-api-framework": (
123127
"https://github.com/maykinmedia/open-api-framework/issues/%s",
124128
"#%s",

‎package-lock.json‎

Lines changed: 12 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "objects",
3-
"version": "3.4.0",
3+
"version": "3.5.0",
44
"description": "objects project",
55
"main": "src/objects/static/bundles/objects-js.js",
66
"directories": {

‎publiccode.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ publiccodeYmlVersion: '0.2'
77
name: Objects API
88
url: 'http://github.com/maykinmedia/objects-api.git'
99
softwareType: standalone/backend
10-
softwareVersion: 3.4.0
11-
releaseDate: '2025-10-28'
10+
softwareVersion: 3.5.0
11+
releaseDate: '2025-12-01'
1212
logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png'
1313
platforms:
1414
- web

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ requires-python = "== 3.12"
66
[tool.bumpversion]
77
commit = false
88
tag = false
9-
current_version = "3.4.0"
9+
current_version = "3.5.0"
1010
pre_commit_hooks = [
1111
"npm i", # ensure that package-lock.json is updated
1212
]

0 commit comments

Comments
 (0)