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

📝 [#3283] Document registration backend migration procedure #4941

Merged
merged 1 commit into from
Dec 18, 2024
Merged

📝 [#3283] Document registration backend migration procedure #4941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/installation/upgrade-300.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,18 @@ The setting ``TEMPORARY_UPLOADS_REMOVED_AFTER_DAYS`` controls how long file uplo
kept. Ensure that this many days have passed since the last legacy upload before
upgrading to Open Forms 3.0, otherwise you will run into database errors during the
upgrade.

Deprecations in registration backends
=====================================

We've done extensive UX rework in the Objects API and ZGW API's registration backends -
you can now select the case and/or document types to use in dropdowns rather than having
to copy-paste the API resource URLs. The API resource URLs will continue to work and
are scheduled for removal in Open Forms 4.0 (no planned date for this yet), but we
recommend you to already migrate your forms to the new format:

* it has a better UX for the people configuring forms :)
* it automatically picks the correct version from the Catalogi API

Migrating is as simple as opening the registration options, selecting the catalogue to
use and then selecting the case type/document type to use and emptying the URL-field.
2 changes: 1 addition & 1 deletion src/openforms/contrib/objects_api/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ class ObjectsAPIGroupConfig(models.Model):
)

# XXX: the URLFields are to be replaced with charfields storing the omschrijving.
# DeprecationWarning: remove in OF 3.0
# DeprecationWarning: remove in OF 4.0
informatieobjecttype_submission_report = models.URLField(
_("submission report informatieobjecttype"),
max_length=1000,
Expand Down
2 changes: 1 addition & 1 deletion src/openforms/registrations/contrib/objects_api/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ class ObjectsAPIOptionsSerializer(JsonSchemaSerializerMixin, serializers.Seriali
),
)

# DeprecationWarning: remove in OF 3.0
# DeprecationWarning: remove in OF 4.0
informatieobjecttype_submission_report = serializers.URLField(
label=_("submission report PDF informatieobjecttype"),
help_text=_(
Expand Down
2 changes: 1 addition & 1 deletion src/openforms/registrations/contrib/objects_api/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class _BaseRegistrationOptions(TypedDict, total=False):
iot_submission_csv: Required[str]
iot_attachment: Required[str]

# DeprecationWarning: URL properties will be removed in OF 3.0
# DeprecationWarning: URL properties will be removed in OF 4.0
informatieobjecttype_submission_report: str
informatieobjecttype_submission_csv: str
informatieobjecttype_attachment: str
Expand Down
2 changes: 1 addition & 1 deletion src/openforms/registrations/contrib/zgw_apis/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ class ZaakOptionsSerializer(JsonSchemaSerializerMixin, serializers.Serializer):
default="",
)

# DeprecationWarning - deprecated, will be removed in OF 3.0 or 4.0
# DeprecationWarning - deprecated, will be removed in OF 4.0
zaaktype = serializers.URLField(
help_text=_("URL of the ZAAKTYPE in the Catalogi API"),
required=False,
Expand Down
Loading