Merge pull request #58 from maykinmedia/issue/fix-oas-check

👷 [maykinmedia/open-api-framework#115] Always run OAS check
maykinmedia · Mar 6, 2025 · e24518d · e24518d
2 parents d95fb6b + c2f3967
commit e24518d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 21 deletions.
diff --git 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'
diff --git 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
@@ -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

diff --git 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."