From bfcf59a7bb75e0a2e514d8ad1937b7de0b3eb050 Mon Sep 17 00:00:00 2001
From: Daniel LaCosse <3759828+daniellacosse@users.noreply.github.com>
Date: Wed, 18 Dec 2024 10:51:02 -0500
Subject: [PATCH] fix(server): fix and validate open API spec (#1626)

* fix(server): fix and validate open API spec

* fix type

* Experimental tag not server
---
 .github/workflows/build_and_test_debug.yml |  6 ++++++
 src/shadowbox/server/api.yml               | 15 ++++++++++-----
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/build_and_test_debug.yml b/.github/workflows/build_and_test_debug.yml
index 890ef8688..39bd1af00 100644
--- a/.github/workflows/build_and_test_debug.yml
+++ b/.github/workflows/build_and_test_debug.yml
@@ -75,6 +75,12 @@ jobs:
       - name: Shadowbox Integration Test
         run: ./task shadowbox:integration_test
 
+      - name: Verify Open API Spec
+        uses: mbowman100/swagger-validator-action@master
+        with:
+          files: |
+            src/shadowbox/server/api.yml
+
   manual-install-script:
     name: Manual Install Script
     runs-on: ubuntu-latest
diff --git a/src/shadowbox/server/api.yml b/src/shadowbox/server/api.yml
index 22450739a..7a7cc0253 100644
--- a/src/shadowbox/server/api.yml
+++ b/src/shadowbox/server/api.yml
@@ -129,7 +129,8 @@ paths:
           description: Access key limit deleted successfully.
   /experimental/server/metrics:
     get:
-      tags: Server
+      tags:
+        - Experimental
       parameters:
         - in: query
           name: since
@@ -158,11 +159,13 @@ paths:
                         tunnelTime:
                           type: object
                           properties:
-                            seconds: number
+                            seconds: 
+                              type: number
                         dataTransferred:
                           type: object
                           properties:
-                            bytes: number
+                            bytes:
+                              type: number
                   accessKeys:
                     type: array
                     items:
@@ -173,11 +176,13 @@ paths:
                         tunnelTime:
                           type: object
                           properties:
-                            seconds: number
+                            seconds: 
+                              type: number
                         dataTransferred:
                           type: object
                           properties:
-                            bytes: number
+                            bytes: 
+                              type: number
               examples:
                 '0':
                   value: '{"server":[{"location":"US","asn":null,"asOrg":null,"tunnelTime":{"seconds":100},"dataTransferred":{"bytes":100}}],"accessKeys":[{"accessKeyId":"0","tunnelTime":{"seconds":100},"dataTransferred":{"bytes":100}}]}'