-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathpublic-api.yml
189 lines (189 loc) · 4.26 KB
/
public-api.yml
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
openapi: "3.0.0"
info:
version: 1.0.0
title: Tsplay.dev public API
license:
name: MIT
servers:
- url: https://tsplay.dev
paths:
'':
get:
summary: Visit Tsplay.dev
operationId: visitTsplay
responses:
'302':
description: Redirect to Tsplay.dev app
headers:
Location:
description: The Tsplay.dev app URL
required: true
schema:
type: string
/healthz:
get:
summary: Health check endpoint
operationId: healthCheck
responses:
'200':
description: The application is healthy
/api/short:
get:
summary: List all shortened URLs
operationId: listAllShorts
responses:
'200':
description: A list of shortened URLs
content:
application/json:
schema:
$ref: "#/components/schemas/ShortenedUrls"
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create a shortened URL
operationId: createShort
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/CreateRequest'
responses:
'201':
description: URL shortened successfully
content:
application/json:
schema:
$ref: "#/components/schemas/ShortenedUrl"
'400':
description: Client error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/short/stats:
get:
summary: Stats
operationId: stats
responses:
'200':
description: Stats
content:
application/json:
schema:
$ref: "#/components/schemas/Stats"
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/{short}:
parameters:
- '$ref': '#/components/parameters/short'
get:
summary: Visit shortened URL
operationId: visitShortened
responses:
'302':
description: TypeScript Playground URL (or app if not found)
headers:
Location:
description: The TypeScript Playground long URL
required: true
schema:
type: string
components:
parameters:
short:
name: short
in: path
required: true
schema:
type: string
schemas:
ShortenedUrl:
type: object
required:
- short
- shortened
- url
- visits
- expires
properties:
short:
type: string
shortened:
type: string
url:
type: string
visits:
type: integer
format: int64
expires:
type: boolean
CreateRequest:
type: object
required:
- url
properties:
url:
type: string
short:
type: string
expires:
type: boolean
created_on:
'$ref': '#/components/schemas/CreatedOn'
CreatedOn:
type: string
enum:
- client
- plugin
- api
- other
ShortenedUrls:
type: array
items:
$ref: "#/components/schemas/ShortenedUrl"
Stats:
type: object
required:
- shortened
- visits
properties:
shortened:
type: integer
format: int64
visits:
type: integer
format: int64
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
Error:
type: object
required:
- message
properties:
message:
type: string