-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
215 lines (213 loc) · 5.18 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
openapi: 3.0.0
info:
title: Ngrok Agent API
version: 1.0.0
servers:
- url: http://127.0.0.1:4040
description: Default Local Server
paths:
/api:
get:
summary: Access the root API resource of a running ngrok agent
responses:
'200':
description: Successful response
/api/tunnels:
get:
summary: List Tunnels
operationId: listTunnels
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelList'
example:
tunnels:
- name: command_line
uri: /api/tunnels/command_line
public_url: https://d95211d2.ngrok.io
proto: https
config:
addr: localhost:80
inspect: true
metrics:
conns:
count: 0
gauge: 0
rate1: 0
rate5: 0
rate15: 0
p50: 0
p90: 0
p95: 0
p99: 0
http:
count: 0
rate1: 0
rate5: 0
rate15: 0
p50: 0
p90: 0
p95: 0
p99: 0
uri: /api/tunnels
post:
summary: Start tunnel
operationId: startTunnel
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelRequest'
responses:
'201':
description: Tunnel started successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelResponse'
/api/tunnels/{name}:
get:
summary: Tunnel detail
operationId: getTunnel
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
example:
$ref: '#/components/schemas/TunnelResponse'
delete:
summary: Stop tunnel
operationId: stopTunnel
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'204':
description: Tunnel stopped successfully
components:
schemas:
TunnelList:
type: object
required:
- tunnels
properties:
tunnels:
type: array
items:
$ref: '#/components/schemas/TunnelResponse'
TunnelRequest:
type: object
properties:
addr:
type: string
proto:
type: string
name:
type: string
required:
- addr
- proto
- name
TunnelResponse:
type: object
required:
- name
- public_url
- config
properties:
name:
type: string
uri:
type: string
format: uri
public_url:
type: string
format: uri
proto:
type: string
config:
type: object
properties:
addr:
type: string
inspect:
type: boolean
required:
- addr
- inspect
metrics:
type: object
properties:
conns:
type: object
properties:
count:
type: integer
gauge:
type: integer
rate1:
type: integer
rate5:
type: integer
rate15:
type: integer
p50:
type: integer
p90:
type: integer
p95:
type: integer
p99:
type: integer
required:
- count
- gauge
- rate1
- rate5
- rate15
- p50
- p90
- p95
- p99
http:
type: object
properties:
count:
type: integer
rate1:
type: integer
rate5:
type: integer
rate15:
type: integer
p50:
type: integer
p90:
type: integer
p95:
type: integer
p99:
type: integer
required:
- count
- rate1
- rate5
- rate15
- p50
- p90
- p95
- p99