Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#513] Release 3.0.0 #517

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

[#513] Release 3.0.0 #517

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c64e8cf
Merge pull request #462 from maykinmedia/release/2.4.4
annashamray Oct 1, 2024
e73a0f4
[#513] Update changelog & README
SonnyBA Jan 8, 2025
547c07e
[#513] bump version for various files
SonnyBA Jan 8, 2025
faec711
[#513] update CHANGELOG & bump version for various files
Jan 9, 2025
549d168
[#513] use more fine-grained search & replace for README's
Jan 9, 2025
2068f10
[#513] undo requirements changes
Jan 9, 2025
00291d3
[#513] remove previously `VERSIONS` setting
Jan 9, 2025
adc7519
[#513] regenerate openapi spec
Jan 9, 2025
5217014
[#513] moved django-setup-configuration upgrade to breaking changes
Jan 9, 2025
871319c
[#513] update warning message
SonnyBA Jan 10, 2025
c0418bc
[#513] update version number & release date
SonnyBA Jan 13, 2025
6648037
[#513] use previous API specification version
SonnyBA Jan 13, 2025
5aaf7af
[#513] revert changes to link for API version
SonnyBA Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .bumpversion.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
[bumpversion]
commit = False
tag = False
current_version = 2.4.3
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
85 changes: 80 additions & 5 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,89 @@
Change history
==============

2.x.x
=====
*TBD*
3.0.0 (2025-01-09)
------------------

**New features**
**Breaking changes**

* removed objects-api V1 [#453]

2.5.0 (2025-01-09)
------------------

**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``.
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]

* Updated OAF version to 0.9.0. This upgrade allows admin users managing their sessions through the admin.
.. 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**
SonnyBA marked this conversation as resolved.
Show resolved Hide resolved

* added documentation for notification retry behavior [#403]
* added missing changelog entry [#455]

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**

* added CI action to check if OAF is up-to-date (#443)

2.4.3 (2024-09-18)
------------------
Expand Down
13 changes: 11 additions & 2 deletions README.NL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Objecten API
============

:Version: 2.4.3
:Version: 3.0.0
:Source: https://github.com/maykinmedia/objecttypes-api
:Keywords: objecten, assets, zaakobjecten

Expand Down Expand Up @@ -38,7 +38,16 @@ 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/2.4.3..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
(`verschillen <https://github.com/maykinmedia/objects-api/compare/3.0.0..master>`_)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as here: https://github.com/maykinmedia/objecttypes-api/pull/149/files#r1917934515

3.0.0 2025-01-09 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.5.0..3.0.0>`_)
2.5.0 2025-01-09 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.5.0/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.5.0/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.4.3..2.5.0>`_)
SonnyBA marked this conversation as resolved.
Show resolved Hide resolved
2.4.4 2024-03-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.4/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.4/src/objects/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objects-api/compare/2.4.3..2.4.4>`_)
2.4.3 2024-03-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.3/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.3/src/objects/api/v2/openapi.yaml>`_
(`verschillen <https://github.com/maykinmedia/objects-api/compare/2.3.0..2.4.3#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
Expand Down
15 changes: 12 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Objects API
===========

:Version: 2.4.3
:Version: 3.0.0
:Source: https://github.com/maykinmedia/objects-api
:Keywords: objects, assets, zaakobjecten

Expand Down Expand Up @@ -36,10 +36,19 @@ 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/2.4.3..master#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
(`diff <https://github.com/maykinmedia/objects-api/compare/3.0.0..master>`_)
3.0.0 2025-01-09 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.5.0..3.0.0>`_)
2.5.0 2025-01-09 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.5.0/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.5.0/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.4.4..2.5.0>`_)
2.4.4 2024-03-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.4/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.4/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.4.3..2.4.4>`_)
2.4.3 2024-03-22 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.3/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.3/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.3.0..2.4.3#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
(`diff <https://github.com/maykinmedia/objects-api/compare/2.3.0..2.4.3>`_)
2.3.0 2024-03-15 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.3.0/src/objects/api/v2/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.3.0/src/objects/api/v2/openapi.yaml>`_
(`diff <https://github.com/maykinmedia/objects-api/compare/2.2.1..2.3.0#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
Expand Down
12 changes: 6 additions & 6 deletions docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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>`__
`Objecttypes API`_ 2.2.2 (
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This applies here too

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it should refer to an unreleased objecttypes but if objecttypes is released first, then I say it should.

Also, should it referrer to Objecttypes 3.0.0 since that will remove also removed API V1

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if the specification version matches the application version necessarily (see my comment at maykinmedia/objecttypes-api#149 (comment))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this version number refers to the specification version, we could refer here to the latest specification version (2.0.0 in this case?) and use the link of the latest application openapi specification (that of 3.0.0) so that we don't link people to older openapi specifications 🤔

`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>`__
)
`Objects API`_ 2.4.3 (
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.3/src/objects/api/v2/openapi.yaml>`__,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/2.4.3/src/objects/api/v2/openapi.yaml>`__
`Objects API`_ 3.0.0 (
`Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`__,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`__
)
====================== ==========================================

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "objects",
"version": "2.4.3",
"version": "3.0.0",
"description": "objects project",
"main": "src/objects/static/bundles/objects-js.js",
"directories": {
Expand Down
4 changes: 2 additions & 2 deletions publiccode.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ publiccodeYmlVersion: '0.2'
name: Objects API
url: 'http://github.com/maykinmedia/objects-api.git'
softwareType: standalone/backend
softwareVersion: 2.4.3
releaseDate: '2021-01-13'
softwareVersion: 3.0.0
releaseDate: '2025-01-09'
SonnyBA marked this conversation as resolved.
Show resolved Hide resolved
logo: 'https://github.com/maykinmedia/objects-api/blob/master/docs/logo.png'
platforms:
- web
Expand Down
2 changes: 1 addition & 1 deletion src/objects/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from .celery import app as celery_app

__all__ = ("celery_app",)
__version__ = "2.4.3"
__version__ = "3.0.0"
__author__ = "Maykin Media"
__homepage__ = "https://github.com/maykinmedia/objects-api"
2 changes: 1 addition & 1 deletion src/objects/api/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Objects API
version: 2.4.3
version: 3.0.0
description: |
An API to manage Objects.

Expand Down
2 changes: 1 addition & 1 deletion src/objects/conf/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
API_VERSION = "2.4.3"
API_VERSION = "3.0.0"

SonnyBA marked this conversation as resolved.
Show resolved Hide resolved
# api settings
REST_FRAMEWORK = {
Expand Down
Loading