Skip to content

Commit bfcf59a

Browse files
fix(server): fix and validate open API spec (#1626)
* fix(server): fix and validate open API spec * fix type * Experimental tag not server
1 parent 9d9f76b commit bfcf59a

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

.github/workflows/build_and_test_debug.yml

+6
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,12 @@ jobs:
7575
- name: Shadowbox Integration Test
7676
run: ./task shadowbox:integration_test
7777

78+
- name: Verify Open API Spec
79+
uses: mbowman100/swagger-validator-action@master
80+
with:
81+
files: |
82+
src/shadowbox/server/api.yml
83+
7884
manual-install-script:
7985
name: Manual Install Script
8086
runs-on: ubuntu-latest

src/shadowbox/server/api.yml

+10-5
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,8 @@ paths:
129129
description: Access key limit deleted successfully.
130130
/experimental/server/metrics:
131131
get:
132-
tags: Server
132+
tags:
133+
- Experimental
133134
parameters:
134135
- in: query
135136
name: since
@@ -158,11 +159,13 @@ paths:
158159
tunnelTime:
159160
type: object
160161
properties:
161-
seconds: number
162+
seconds:
163+
type: number
162164
dataTransferred:
163165
type: object
164166
properties:
165-
bytes: number
167+
bytes:
168+
type: number
166169
accessKeys:
167170
type: array
168171
items:
@@ -173,11 +176,13 @@ paths:
173176
tunnelTime:
174177
type: object
175178
properties:
176-
seconds: number
179+
seconds:
180+
type: number
177181
dataTransferred:
178182
type: object
179183
properties:
180-
bytes: number
184+
bytes:
185+
type: number
181186
examples:
182187
'0':
183188
value: '{"server":[{"location":"US","asn":null,"asOrg":null,"tunnelTime":{"seconds":100},"dataTransferred":{"bytes":100}}],"accessKeys":[{"accessKeyId":"0","tunnelTime":{"seconds":100},"dataTransferred":{"bytes":100}}]}'

0 commit comments

Comments
 (0)