From 5bba0bfa63c21902698008e6aef4cc6ca4800fb2 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Thu, 6 Mar 2025 15:20:26 +0100 Subject: [PATCH 1/3] :construction_worker: [maykinmedia/open-api-framework#115] Always run OAS check to verify that the schema is up to date --- .github/workflows/oas-check.yml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/.github/workflows/oas-check.yml b/.github/workflows/oas-check.yml index 6149de0..5456e7d 100644 --- a/.github/workflows/oas-check.yml +++ b/.github/workflows/oas-check.yml @@ -2,19 +2,13 @@ name: check-oas on: push: - paths: - - "src/referentielijsten/api/openapi.yaml" - - ".github/workflows/oas-check.yml" - branches: - - '**' workflow_dispatch: jobs: open-api-workflow-check-oas: - uses: maykinmedia/open-api-workflows/.github/workflows/oas-check.yml@v1 + uses: maykinmedia/open-api-workflows/.github/workflows/oas-check.yml@v5.0.0 with: python-version: '3.11' - schema-path: 'src/referentielijsten/api/openapi.yaml' - + schema-options: 'src/referentielijsten/api/openapi.yaml' django-settings-module: 'referentielijsten.conf.ci' From 018f9b38390b20b378a2eec7e48179abfc87ea2c Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Thu, 6 Mar 2025 15:23:57 +0100 Subject: [PATCH 2/3] :speech_balloon: Add missing translations for pagination params --- .../conf/locale/nl/LC_MESSAGES/django.po | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/referentielijsten/conf/locale/nl/LC_MESSAGES/django.po b/src/referentielijsten/conf/locale/nl/LC_MESSAGES/django.po index 0950627..92ea79b 100644 --- a/src/referentielijsten/conf/locale/nl/LC_MESSAGES/django.po +++ b/src/referentielijsten/conf/locale/nl/LC_MESSAGES/django.po @@ -280,3 +280,11 @@ msgstr "Ongeldige postcode." #: referentielijsten/utils/validators.py:32 msgid "Invalid mobile phonenumber." msgstr "Ongeldig mobiel telefoonnumer." + +#: conf/base.py:200 +msgid "A page number within the paginated result set." +msgstr "Een pagina binnen de gepagineerde set resultaten." + +#: conf/base.py:201 +msgid "Number of results to return per page." +msgstr "Het aantal resultaten terug te geven per pagina." From c2f3967633d381e23ce9dd5e24e3e24ece5f5a31 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Thu, 6 Mar 2025 15:24:31 +0100 Subject: [PATCH 3/3] :memo: [maykinmedia/open-api-framework#115] Regenerate schema --- bin/generate_schema.sh | 5 ++++- src/referentielijsten/api/openapi.yaml | 12 ------------ 2 files changed, 4 insertions(+), 13 deletions(-) diff --git a/bin/generate_schema.sh b/bin/generate_schema.sh index 9074d68..930f859 100755 --- a/bin/generate_schema.sh +++ b/bin/generate_schema.sh @@ -4,4 +4,7 @@ # # Run this script from the root of the repository -src/manage.py spectacular --file src/referentielijsten/api/openapi.yaml --validate +src/manage.py spectacular \ + --file src/referentielijsten/api/openapi.yaml \ + --validate \ + --lang="nl-nl" diff --git a/src/referentielijsten/api/openapi.yaml b/src/referentielijsten/api/openapi.yaml index 0986bf6..cfba1c5 100644 --- a/src/referentielijsten/api/openapi.yaml +++ b/src/referentielijsten/api/openapi.yaml @@ -93,18 +93,6 @@ components: schemas: Beheerder: type: object - description: |- - Generate a serializer out of a GegevensGroepType. - - Usage:: - - >>> class VerlengingSerializer(GegevensGroepSerializer): - ... class Meta: - ... model = Zaak - ... gegevensgroep = 'verlenging' - >>> - - Where ``Zaak.verlenging`` is a :class:``GegevensGroepType``. properties: naam: type: string