*: replace swagger with openapi

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>

.github/workflows/release.yml

@@ -30,7 +30,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: prepare ts api client
         run: |
-          docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/swagger.yaml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
+          docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/schema.yml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
       - name: Building Docker Image
         uses: docker/build-push-action@v2
         with:
@@ -53,7 +53,7 @@ jobs:
         run: |
           cd outpost
           go get -u github.com/go-swagger/go-swagger/cmd/swagger
-          swagger generate client -f ../swagger.yaml -A authentik -t pkg/
+          swagger generate client -f ../schema.yml -A authentik -t pkg/
           go build -v ./cmd/proxy/server.go
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1.1.0
@@ -93,7 +93,7 @@ jobs:
         run: |
           cd outpost
           go get -u github.com/go-swagger/go-swagger/cmd/swagger
-          swagger generate client -f ../swagger.yaml -A authentik -t pkg/
+          swagger generate client -f ../schema.yml -A authentik -t pkg/
           go build -v ./cmd/ldap/server.go
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1.1.0

.github/workflows/tag.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: prepare ts api client
         run: |
-          docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/swagger.yaml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
+          docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/schema.yml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
       - name: Pre-release test
         run: |
           sudo apt-get install -y pwgen

Makefile

@@ -26,7 +26,7 @@ lint:
 	pylint authentik tests lifecycle
 
 gen:
-	./manage.py spectacular --file schema.yaml --validate --fail-on-warn
+	./manage.py spectacular --file schema.yml
 	docker run \
 		--rm -v ${PWD}:/local \
 		openapitools/openapi-generator-cli generate \

authentik/api/views.py

@@ -13,10 +13,7 @@ class SwaggerView(TemplateView):
     def get_context_data(self, **kwargs: Any) -> dict[str, Any]:
         path = self.request.build_absolute_uri(
             reverse(
-                "authentik_api:schema-json",
-                kwargs={
-                    "format": ".json",
-                },
+                "authentik_api:schema",
             )
         )
         return super().get_context_data(path=path, **kwargs)

authentik/root/settings.py

@@ -154,6 +154,7 @@ SPECTACULAR_SETTINGS = {
     "ENUM_NAME_OVERRIDES": {
         "ChallengeChoices": "authentik.flows.challenge.ChallengeTypes"
     },
+    "ENUM_ADD_EXPLICIT_BLANK_NULL_CHOICE": False
 }
 
 REST_FRAMEWORK = {

azure-pipelines.yml

@@ -298,7 +298,7 @@ stages:
             displayName: Build static files for e2e
             inputs:
               script: |
-                docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/swagger.yaml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
+                docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/schema.yml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
                 sudo chmod 777 -R web/api/
                 cd web
                 cd api && npm i && cd ..
@@ -399,7 +399,7 @@ stages:
           - task: CmdLine@2
             inputs:
               script: |
-                docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/swagger.yaml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
+                docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/schema.yml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
           - task: PublishPipelineArtifact@1
             inputs:
               targetPath: 'web/api/'

outpost/Makefile

@@ -2,7 +2,7 @@ all: clean generate
 
 generate:
 	go get -u github.com/go-swagger/go-swagger/cmd/swagger
-	swagger generate client -f ../swagger.yaml -A authentik -t pkg/
+	swagger generate client -f ../schema.yml -A authentik -t pkg/
 
 run:
 	go run -v .

outpost/azure-pipelines.yml

@@ -28,7 +28,7 @@ stages:
                 sudo wget -O /usr/local/bin/swagger https://github.com/go-swagger/go-swagger/releases/latest/download/swagger_linux_amd64
                 sudo chmod +x /usr/local/bin/swagger
                 mkdir -p $(go env GOPATH)
-                swagger generate client -f ../swagger.yaml -A authentik -t pkg/
+                swagger generate client -f ../schema.yml -A authentik -t pkg/
               workingDirectory: 'outpost/'
           - task: PublishPipelineArtifact@1
             inputs:

web/azure-pipelines.yml

@@ -20,7 +20,7 @@ stages:
           - task: CmdLine@2
             inputs:
               script: |
-                docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/swagger.yaml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
+                docker run --rm -v $(pwd):/local openapitools/openapi-generator-cli generate -i /local/schema.yml -g typescript-fetch -o /local/web/api --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0
           - task: PublishPipelineArtifact@1
             inputs:
               targetPath: 'web/api/'

website/developer-docs/local-dev-environment.md

@@ -44,7 +44,7 @@ If you want to generate the client without installing anything, run this command
 docker run \
   --rm -v $(pwd):/local \
   openapitools/openapi-generator-cli generate \
-  -i /local/swagger.yaml \
+  -i /local/schema.yml \
   -g typescript-fetch \
   -o /local/web/api \
   --additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=authentik-api,npmVersion=1.0.0

website/src/pages/api.jsx

@@ -10,7 +10,7 @@ function APIBrowser() {
     return (
         <Layout title="API Browser" description={siteConfig.tagline}>
             <rapi-doc
-                spec-url={useBaseUrl("swagger.yaml")}
+                spec-url={useBaseUrl("schema.yml")}
                 allow-try="false"
                 show-header="false"
                 theme="dark"

website/static/schema.yaml

@@ -0,0 +1 @@
+../../schema.yml