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 #149

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

[#513] Release 3.0.0 #149

wants to merge 8 commits into from

Conversation

SonnyBA
Copy link
Contributor

@SonnyBA SonnyBA commented Jan 10, 2025

Partially fixes maykinmedia/objects-api#513

Changes

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

@@ -1,6 +1,6 @@
from vng_api_common.conf.api import * # noqa - imports white-listed

API_VERSION = "2.2.2"
API_VERSION = "3.0.0"
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 we need to increase this to v3+ right now, since we still use the v2 endpoint. This would increase to 3.0.0+ if we actually make breaking changes to the API itself.

I don't think we've been updating this version the right way though, I guess technically it should be increased dependent on whether or not there have been major/minor/patch changes to the API. Since this release doesn't change the v2 API, I think we should leave this number unchanged.

@SonnyBA SonnyBA self-assigned this Jan 10, 2025
@SonnyBA SonnyBA marked this pull request as ready for review January 10, 2025 13:42
Comment on lines +39 to +45
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/3.0.0..master>`_)
3.0.0 2025-01-10 `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>`_)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/3.0.0..master>`_)
3.0.0 2025-01-10 `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>`_)
(`verschillen <https://github.com/maykinmedia/objecttypes-api/compare/3.0.0..master>`_)
3.0.0 2025-01-10 `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>`_)

@@ -111,6 +111,25 @@ paths:
/objecttypes/{objecttype_uuid}/versions:
get:
operationId: objectversion_list
description: |-
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 these descriptions were added intentionally, could you either remove them or add a more correct description of ObjectVersion?

@@ -1,6 +1,6 @@
from vng_api_common.conf.api import * # noqa - imports white-listed

API_VERSION = "2.2.2"
API_VERSION = "3.0.0"
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 we need to increase this to v3+ right now, since we still use the v2 endpoint. This would increase to 3.0.0+ if we actually make breaking changes to the API itself.

I don't think we've been updating this version the right way though, I guess technically it should be increased dependent on whether or not there have been major/minor/patch changes to the API. Since this release doesn't change the v2 API, I think we should leave this number unchanged.

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
3 participants