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.

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

wants to merge 13 commits into from

Conversation

SonnyBA
Copy link
Contributor

@SonnyBA SonnyBA commented Jan 9, 2025

Partially fixes #513

Changes

Adds changes required for releasing 3.0.0. This is the major release part.

`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 🤔

@SonnyBA SonnyBA self-assigned this Jan 9, 2025
@SonnyBA SonnyBA marked this pull request as ready for review January 9, 2025 15:28
src/objects/conf/api.py Outdated Show resolved Hide resolved
Copy link
Contributor

@Coperh Coperh left a comment

Choose a reason for hiding this comment

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

Looks good

`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

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

@Coperh
Copy link
Contributor

Coperh commented Jan 10, 2025

With this, are we removing support for Objecttypes-api < 3.0.0?

CHANGELOG.rst Outdated Show resolved Hide resolved
README.NL.rst Outdated Show resolved Hide resolved
`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

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

package-lock.json Outdated Show resolved Hide resolved
package-lock.json Outdated Show resolved Hide resolved
publiccode.yaml Outdated Show resolved Hide resolved
src/objects/conf/api.py Outdated Show resolved Hide resolved
@SonnyBA SonnyBA requested a review from stevenbal January 13, 2025 15:49
Copy link
Contributor

@stevenbal stevenbal left a comment

Choose a reason for hiding this comment

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

Just the question remaining about the listed API spec versions in the readme, but since that seems to be incorrect on main already, I won't let it block this release

@@ -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.

@@ -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>`_)
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,
Copy link
Contributor

Choose a reason for hiding this comment

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

Reminder to change this date to when it's going to be released

Suggested change
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,
3.0.0 2025-01-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,

@@ -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-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,
Copy link
Contributor

Choose a reason for hiding this comment

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

Reminder to change this date to when it's going to be released

Suggested change
3.0.0 2025-01-14 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,
3.0.0 2025-01-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.0.0/src/objects/api/v2/openapi.yaml>`_,

softwareVersion: 2.4.3
releaseDate: '2021-01-13'
softwareVersion: 3.0.0
releaseDate: '2025-01-14'
Copy link
Contributor

Choose a reason for hiding this comment

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

Reminder to change this when it's released

2.x.x
=====
*TBD*
3.0.0 (2025-01-14)
Copy link
Contributor

Choose a reason for hiding this comment

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

Reminder to change this when it's released

@Hugo-ter-Doest
Copy link
Collaborator

This is not breaking for OF, ZAC, KISS, OIP, ABC. I checked this with the PO's.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Objects / Objecttypes API release
5 participants