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

👷 [maykinmedia/open-api-framework#115] Always run OAS check
maykinmedia · Mar 7, 2025 · eab1209 · eab1209
2 parents 88f5939 + b2b87fa
commit eab1209
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 17 deletions.
diff --git a/.github/workflows/check-oas.yml b/.github/workflows/check-oas.yml
@@ -2,22 +2,15 @@ name: check-oas
 
 on:
   push:
-    paths:
-      - "src/objecttypes/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
-    strategy:
-      matrix:
-        version:
-          - v2
+    uses: maykinmedia/open-api-workflows/.github/workflows/oas-check.yml@v5.0.0
     with:
-      schema-path: 'src/objecttypes/api/${{ matrix.version }}/openapi.yaml'
+      schema-path: 'src/objecttypes/api/v2/openapi.yaml'
+      schema-options: 'src/objecttypes/api/v2/openapi.yaml'
       python-version: '3.11'
       django-settings-module: 'objecttypes.conf.ci'
+      schema-command: bin/generate_schema.sh
       apt-packages: 'libgdal-dev gdal-bin'
diff --git a/bin/generate_schema.sh b/bin/generate_schema.sh
@@ -8,4 +8,4 @@ export SCHEMA_PATH=src/objecttypes/api/v2/openapi.yaml
 
 OUTPUT_FILE=$1
 
-src/manage.py spectacular --file ${OUTPUT_FILE:-$SCHEMA_PATH} --validate
+src/manage.py spectacular --file ${OUTPUT_FILE:-$SCHEMA_PATH} --validate --lang="en"
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -56,7 +56,7 @@ click-plugins==1.1.1
     # via celery
 click-repl==0.2.0
     # via celery
-commonground-api-common==2.5.1
+commonground-api-common==2.5.2
     # via open-api-framework
 coreapi==2.3.3
     # via commonground-api-common

diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -110,7 +110,7 @@ click-repl==0.2.0
     #   celery
 codecov==2.1.13
     # via -r requirements/test-tools.in
-commonground-api-common==2.5.1
+commonground-api-common==2.5.2
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt

diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -134,7 +134,7 @@ codecov==2.1.13
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-commonground-api-common==2.5.1
+commonground-api-common==2.5.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt

diff --git a/src/objecttypes/api/v2/openapi.yaml b/src/objecttypes/api/v2/openapi.yaml
@@ -449,11 +449,11 @@ components:
         url:
           type: string
           format: uri
+          readOnly: true
           minLength: 1
           maxLength: 1000
           description: URL reference to this object. This is the unique identification
             and location of this object.
-          readOnly: true
         uuid:
           type: string
           format: uuid
@@ -657,11 +657,11 @@ components:
         url:
           type: string
           format: uri
+          readOnly: true
           minLength: 1
           maxLength: 1000
           description: URL reference to this object. This is the unique identification
             and location of this object.
-          readOnly: true
         uuid:
           type: string
           format: uuid
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ export SCHEMA_PATH=src/objecttypes/api/v2/openapi.yaml

		OUTPUT_FILE=$1

		src/manage.py spectacular --file ${OUTPUT_FILE:-$SCHEMA_PATH} --validate
		src/manage.py spectacular --file ${OUTPUT_FILE:-$SCHEMA_PATH} --validate --lang="en"