-
Notifications
You must be signed in to change notification settings - Fork 15
Description
Placeholder to keep track of what needs to be removed/changed in this major release
- Rename
LOG_REQUESTStoLOG_OUTGOING_REQUESTS(change in OAF? or override locally? https://github.com/maykinmedia/open-api-framework/blob/f54907d65adfaa5dd6fd2bdaa634bbacb8b457d0/open_api_framework/conf/base.py#L552) and renameENABLE_STRUCTLOG_REQUESTStoLOG_REQUESTS - Use
CELERY_BROKER_URLenvvar forCELERY_BROKER_URLsetting (currently usesCELERY_RESULT_BACKENDas per OAF https://github.com/maykinmedia/open-api-framework/blob/a9eb1d76f22c6b3fddf4969cd30bcf7783cd1f1a/open_api_framework/conf/base.py#L1285) - Remove deprecated views for OpenAPI specs (#2189) (
DeprecationRedirectView) - See if any upgrade check constraints need to be added
- Remove
django.contrib.sitesand related config step- check register_kanalen
- use new exception_handler from commonground-api-common (which updates error format to be application/problem+json compliant)
- other setupconfig changes?
- TODO check more deprecations and
XXX: ...comments - Rename to Open Object
- Squash migrations (?)
- Should we release API v3 as well? maybe a separate issue to define a v3 for the API
- then we could deprecate
data_attr - data_icontains simplify to use _icontains and add separate regex search query param?
- then we could deprecate
Release checklist
- Resolve release blockers
- Upgrade
open-api-frameworkto latest version - Check security tab and upgrade packages to fix vulnerabilities
- Check translations
- Bump API version number (if applicable)
- Version bump
- Regenerate API spec
- Update READMEs with release dates + links
- Bump version number with
bin/bump-my-version.sh bump <major|minor|patch> - Update changelog (check how OF lists breaking changes)
- Add changelog entry + warning for Objecttypes migration
- mention that Objects now ignores the domain of the objecttype and only checks the path, meaning that doing POST with URL reference to the external objecttypes API still work (but will use the internal objecttype with that UUID)
- Mention that namespace for OTel metrics changed: https://github.com/maykinmedia/objects-api/pull/737/changes#r2932221728
- changes to setupconfig for objecttypes -> service and use_fields and fields removed (should we remove the step altogether?)
- Add changelog entry + warning for Objecttypes migration
- Check the impact of this release on the Helm charts and make issues for this in https://github.com/maykinmedia/charts if needed, e.g.
- New environment variables were added
- New setup configuration steps or changes to format
- New containers required
- ...
To test
- From which version to 4.0 upgrade is upgrade check enforced?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
In Progress