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

✨ [#4789] ConfigurationStep for ZGW API registration config #4876

Merged
merged 5 commits into from
Dec 9, 2024

Conversation

stevenbal
Copy link
Contributor

@stevenbal stevenbal commented Dec 2, 2024

Closes #4789
Closes #4532

Changes

  • Add identifier field to ZGWAPIGroupConfig
  • ConfigurationStep for ZGW API registration config

Checklist

Check off the items that are completed or not relevant.

  • Impact on features

    • Checked copying a form
    • Checked import/export of a form
    • Config checks in the configuration overview admin page
    • Problem detection in the admin email digest is handled
  • Release management

    • I have labelled the PR as "needs-backport" accordingly
  • I have updated the translations assets (you do NOT need to provide translations)

    • Ran ./bin/makemessages_js.sh
    • Ran ./bin/compilemessages_js.sh
  • Commit hygiene

    • Commit messages refer to the relevant Github issue
    • Commit messages explain the "why" of change, not the how

@stevenbal stevenbal marked this pull request as draft December 2, 2024 10:42
Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.61%. Comparing base (ae74347) to head (6635402).
Report is 7 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4876   +/-   ##
=======================================
  Coverage   96.60%   96.61%           
=======================================
  Files         754      756    +2     
  Lines       25853    25888   +35     
  Branches     3415     3416    +1     
=======================================
+ Hits        24976    25011   +35     
  Misses        613      613           
  Partials      264      264           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stevenbal stevenbal force-pushed the feature/setup-configuration branch from 67390e6 to 6024de6 Compare December 2, 2024 14:13
@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch from 069904d to 3e4729c Compare December 2, 2024 14:28
@stevenbal stevenbal force-pushed the feature/setup-configuration branch 2 times, most recently from 4380c06 to 5cb5618 Compare December 2, 2024 14:35
@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch 2 times, most recently from d9e3c8d to ee7fe3b Compare December 2, 2024 16:29
@stevenbal stevenbal force-pushed the feature/setup-configuration branch 2 times, most recently from 4f92c5b to 0d16714 Compare December 3, 2024 14:01
@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch from ee7fe3b to 71e813c Compare December 3, 2024 14:03
@stevenbal stevenbal marked this pull request as ready for review December 3, 2024 14:19
@stevenbal stevenbal force-pushed the feature/setup-configuration branch 2 times, most recently from edd2b72 to 07c23a6 Compare December 6, 2024 15:26
Base automatically changed from feature/setup-configuration to master December 6, 2024 15:28
to make sure there is a unique field that can be used to refer to the groups and identify them when they are loaded using setup-configuration
@stevenbal stevenbal marked this pull request as draft December 6, 2024 15:37
@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch 2 times, most recently from f7297fb to d228755 Compare December 6, 2024 16:29
ZGWApiGroupConfig, "content_json"
)

# FIXME choices and blank=True doesn't seem to be picked up properly
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Created an issue in django-setup-configuration for this maykinmedia/django-setup-configuration#27

@stevenbal stevenbal marked this pull request as ready for review December 6, 2024 16:42
@stevenbal
Copy link
Contributor Author

@sergei-maertens I rebased and this PR is now ready for review

@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch from d228755 to cc0d8bf Compare December 9, 2024 08:13
Comment on lines +79 to +87
objects_api_json_content_template: |
{
"data": {% json_summary %},
"type": "{{ productaanvraag_type }}",
"bsn": "{{ variables.auth_bsn }}",
"submission_id": "{{ submission.kenmerk }}",
"language_code": "{{ submission.language_code }}",
"custom_field": "foo"
}
Copy link
Member

Choose a reason for hiding this comment

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

I only now realize you can't specify an objects API group at the model level 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is this the same issue as previously with objects API registration where it would always use the group with the lowest pk?

@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch from cc0d8bf to fd0d626 Compare December 9, 2024 08:45
this step relies on the previously added ServiceConfigurationStep and can be used to set up the necessary configuration for the ZGW API registration backend
@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch from fd0d626 to df117af Compare December 9, 2024 08:48
@stevenbal
Copy link
Contributor Author

@sergei-maertens I was running into 504 errors in the generate SDK jobs: https://github.com/open-formulieren/open-forms/actions/runs/12231486625/job/34115402181, I hope this fixes it: 67db7c4

the generate-sdks job was failing due to some network calls that were performed when validating the OAS, this is avoided by specifying the version of the generator-cli in openapitools.json

see also: OpenAPITools/openapi-generator-cli#802
@stevenbal stevenbal force-pushed the feature/4789-zgw-setup-config branch from 67db7c4 to 6635402 Compare December 9, 2024 09:54
@sergei-maertens sergei-maertens merged commit a25d84b into master Dec 9, 2024
34 checks passed
@sergei-maertens sergei-maertens deleted the feature/4789-zgw-setup-config branch December 9, 2024 14:29
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.

Add support for ZGW-groups configuration via django-setup-configuration
2 participants