🔖 [#691] Release version 3.4.0

stevenbal · stevenbal · commit 80c1c23400e1 · 2025-10-28T11:42:11.000+01:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,37 @@
 Change history
 ==============
 
+3.4.0 (2025-10-28)
+------------------
+
+.. warning::
+
+  This version contains a data migration which denormalizes the ``object_type`` on the ObjectRecord
+  model to make queries more performant, by avoiding additional JOINs.
+
+  This data migration can take around **40 minutes to 1.5 hours**, dependent
+  on the amount of ObjectRecords in the database. It was tested on a dataset of 3.8 million
+  ObjectRecords, for which this migration took 45 minutes. This data migration does handle newly
+  created ObjectRecords if the Objects API is still running simultaneously.
+
+  If the Objects API is still running while this migration is applied and if there is
+  always a constant influx of created ObjectRecords, this migration could theoretically
+  keep running indefinitely, or there could be a small window (if the data migration does finish)
+  where the ``NOT NULL`` constraint is not yet applied and ``NULL`` values are being inserted,
+  causing errors. Although this is unlikely, if your instance is at risk for this,
+  it could be safer to take the Objects API offline before migrating to avoid this.
+
+**Performance optimizations**
+
+* [#677] Denormalize ``ObjectRecord`` by adding ``_object_type`` to avoid JOINs in queries.
+  This improves performance for read operations via the API.
+
+**Project maintenance**
+
+* [:open-api-framework:`163`] Integrate django-common to make uses of shared views/templates
+* [:objects-api:`663`] Upload performance tests results to bencher
+* [:open-api-workflows:`30`] Run API Design Rules linter on OpenAPI specification in CI
+
 3.3.1 (2025-10-16)
 ------------------
 
diff --git a/README.NL.rst b/README.NL.rst
@@ -2,7 +2,7 @@
 Objecten API
 ============
 
-:Version: 3.3.1
+:Version: 3.4.0
 :Source: https://github.com/maykinmedia/objecttypes-api
 :Keywords: objecten, assets, zaakobjecten
 
@@ -38,7 +38,13 @@ Applicatie versie       Release datum   API specificatie
 =================       ==============  =============================
 latest                  n/a             `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
                                         `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
-                                        (`verschillen <https://github.com/maykinmedia/objects-api/compare/3.3.0..master>`_)
+                                        (`verschillen <https://github.com/maykinmedia/objects-api/compare/3.4.0..master>`_)
+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>`_,
+                                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`_
+                                        (`verschillen <https://github.com/maykinmedia/objects-api/compare/3.3.1..3.4.0>`_)
+3.3.1                   2025-10-16      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`_,
+                                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`_
+                                        (`verschillen <https://github.com/maykinmedia/objects-api/compare/3.3.0..3.3.1>`_)
 3.3.0                   2025-10-02      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.0/src/objects/api/v2/openapi.yaml>`_,
                                         `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.0/src/objects/api/v2/openapi.yaml>`_
                                         (`verschillen <https://github.com/maykinmedia/objects-api/compare/3.2.0..3.3.0>`_)
diff --git a/README.rst b/README.rst
@@ -2,7 +2,7 @@
 Objects API
 ===========
 
-:Version: 3.3.1
+:Version: 3.4.0
 :Source: https://github.com/maykinmedia/objects-api
 :Keywords: objects, assets, zaakobjecten
 
@@ -36,7 +36,13 @@ Application version     Release date    API specification
 ===================     ==============  =============================
 latest                  n/a             `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
                                         `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/master/src/objects/api/v2/openapi.yaml>`_,
-                                        (`diff <https://github.com/maykinmedia/objects-api/compare/3.3.0..master>`_)
+                                        (`diff <https://github.com/maykinmedia/objects-api/compare/3.4.0..master>`_)
+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>`_,
+                                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`_
+                                        (`diff <https://github.com/maykinmedia/objects-api/compare/3.3.1..3.4.0>`_)
+3.3.1                   2025-10-16      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`_,
+                                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`_
+                                        (`diff <https://github.com/maykinmedia/objects-api/compare/3.3.0..3.3.1>`_)
 3.3.0                   2025-10-02      `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.0/src/objects/api/v2/openapi.yaml>`_,
                                         `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.0/src/objects/api/v2/openapi.yaml>`_
                                         (`diff <https://github.com/maykinmedia/objects-api/compare/3.2.0..3.3.0>`_)
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -15,8 +15,8 @@ API                     Specification version(s)
                         `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.3/src/objecttypes/api/v2/openapi.yaml>`__
                         )
 `Objects API`_          2.4.4 (
-                        `Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`__,
-                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`__
+                        `Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`__,
+                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.4.0/src/objects/api/v2/openapi.yaml>`__
                         )
 ======================  ==========================================
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -123,6 +123,10 @@
         "https://github.com/maykinmedia/open-api-framework/issues/%s",
         "#%s",
     ),
+    "open-api-workflows": (
+        "https://github.com/maykinmedia/open-api-workflows/issues/%s",
+        "#%s",
+    ),
     "charts": (
         "https://github.com/maykinmedia/charts/issues/%s",
         "#%s",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "objects",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "objects project",
   "main": "src/objects/static/bundles/objects-js.js",
   "directories": {
diff --git 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: 3.3.1
-releaseDate: '2025-10-16'
+softwareVersion: 3.4.0
+releaseDate: '2025-10-28'
 logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png'
 platforms:
   - web
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ requires-python = "== 3.12"
 [tool.bumpversion]
 commit = false
 tag = false
-current_version = "3.3.1"
+current_version = "3.4.0"
 pre_commit_hooks = [
     "npm i",  # ensure that package-lock.json is updated
 ]
diff --git 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__ = "3.3.1"
+__version__ = "3.4.0"
 __author__ = "Maykin Media"
 __homepage__ = "https://github.com/maykinmedia/objects-api"

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ API Specification version(s)`
`15`	`15`	`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.0.3/src/objecttypes/api/v2/openapi.yaml>`__
`16`	`16`	`)`
`17`	`17`	`Objects API`_ 2.4.4 (
`18`		- `Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`__,
`19`		- `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.3.1/src/objects/api/v2/openapi.yaml>`__
	`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>`__
`20`	`20`	`)`
`21`	`21`	`====================== ==========================================`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "objects",`
`3`		`- "version": "3.3.1",`
	`3`	`+ "version": "3.4.0",`
`4`	`4`	`"description": "objects project",`
`5`	`5`	`"main": "src/objects/static/bundles/objects-js.js",`
`6`	`6`	`"directories": {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ requires-python = "== 3.12"`
`6`	`6`	`[tool.bumpversion]`
`7`	`7`	`commit = false`
`8`	`8`	`tag = false`
`9`		`-current_version = "3.3.1"`
	`9`	`+current_version = "3.4.0"`
`10`	`10`	`pre_commit_hooks = [`
`11`	`11`	`"npm i", # ensure that package-lock.json is updated`
`12`	`12`	`]`