This repository has been archived by the owner on Jul 8, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsecoda-openapi.yml
389 lines (389 loc) · 9.02 KB
/
secoda-openapi.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
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
openapi: 3.0.0
info:
title: secoda-api
contact:
name: Sawyer Waugh
version: '1.0'
description: Ported from official documentation
servers:
- url: 'https://api.secoda.co'
description: prod
tags:
- name: table
description: Resources classified as Tables
externalDocs:
url: 'http://docs.my-api.com/pet-operations.htm'
- name: column
description: Fields originating in Table Resources
externalDocs:
url: 'http://docs.my-api.com/store-orders.htm'
- name: dictionary
description: A curated collection of org-defined terms
externalDocs:
url: 'http://docs.my-api.com/store-orders.htm'
- name: collection
description: 'Resources, docs and questions grouped by tag'
externalDocs:
url: 'http://docs.my-api.com/store-orders.htm'
paths:
/table:
get:
summary: List All Tables
tags:
- table
responses:
'200':
description: OK
operationId: get-tables
description: List All Tables
parameters: []
post:
summary: Create New Table
operationId: post-table
responses:
'200':
description: OK
description: |-
Create New Table.
*Not yet supported*
tags:
- table
'/table/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The id of the table
get:
summary: Get Specific Table
tags:
- table
responses:
'200':
description: OK
operationId: get-table-id
description: Get table by id
put:
summary: Update Table
operationId: put-table-id
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
msg:
type: string
minLength: 1
required:
- msg
x-examples:
example-1:
msg: Successfully updated table
tags:
- table
description: Update Table by id
'/table/{id}/columns':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The id of the table
get:
summary: Get All Table Columns
tags:
- table
- column
responses:
'200':
description: OK
operationId: get-table-id-columns
description: Retrieve all columns from a specific table.
put:
summary: Update Table Column
operationId: update-table-id-columns
responses:
'200':
description: OK
description: Update column `name` from table `id`.
tags:
- table
- column
delete:
summary: Delete Table Column
operationId: delete-table-id-columns
responses:
'200':
description: OK
parameters:
- schema:
type: string
in: query
name: name
description: The name of the column
description: Delete column `name` from table `id`.
tags:
- table
- column
/dictionary:
get:
summary: List All Dictionary Terms
tags:
- dictionary
responses:
'200':
description: OK
operationId: get-dictionary
description: Get all dictionary terms.
post:
summary: Create a New Dictionary Term
operationId: post-dictionary
responses:
'200':
description: OK
description: Create a new dictionary term
tags:
- dictionary
'/dictionary/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: A dictionary term id
get:
summary: Get Specific Dictionary Term
tags:
- dictionary
responses:
'200':
description: OK
description: Retrieve a specific dictionary term.
operationId: get-dictionary-id
put:
summary: Update Dictionary Term
operationId: put-dictionary-id
responses:
'200':
description: OK
description: Update a specific dictionary term.
tags:
- dictionary
delete:
summary: Delete Dictionary Term
operationId: delete-dictionary-id
responses:
'200':
description: OK
parameters: []
description: Delete a specific dictionary term.
tags:
- dictionary
/tag:
get:
summary: List All Collections
tags:
- collection
responses:
'200':
description: OK
operationId: get-tag
description: List all collections
post:
summary: Create a new Collection
operationId: post-tag
responses:
'200':
description: OK
description: Create a new Collection
tags:
- collection
'/tag/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
get:
summary: Get Specific Collection
tags:
- collection
responses:
'200':
description: OK
operationId: get-tag-id
description: Retrieve a collection by id
put:
summary: Update Collection
operationId: put-tag-id
responses:
'200':
description: OK
description: Update a collection by id
tags:
- collection
delete:
summary: Delete Collection
operationId: delete-tag-id
responses:
'200':
description: OK
tags:
- collection
description: Delete a collection by id.
/user/invite:
post:
summary: Invite a New User
operationId: post-user-invite
responses:
'200':
description: OK
description: Invite a new User. Accepts `email` and `role`.
components:
schemas:
Table:
description: ''
type: object
x-examples:
example-1:
id: 7o7y2s75ktirezg6__bigquery__secoda-web__dbt_amcewen__customers
neo4j_id: '7o7y2s75ktirezg6~bigquery://secoda-web.dbt_amcewen/customers'
created_at: None
updated_at: None
tags:
- 7o7y2s75ktirezg6~dbt_tag
name: customers
schema: dbt_amcewen
cluster: secoda-web
database: bigquery
owners: None
description: Description of table
columns:
- customer_id
- first_name
- last_name
- first_order_date
- most_recent_order_date
- number_of_orders
queries:
- description: None
query_text: SELECT * FROM tickets.users
frequency: 0
last_updated_timestamp: None
key: ''
- description: None
query_text: SELECT * FROM dbt_amcewen.customers
frequency: 0
last_updated_timestamp: None
key: ''
title: Table
properties:
id:
type: string
x-tags:
- table
Dictionary:
title: Dictionary
type: object
properties:
id:
type: string
x-tags:
- dictionary
Term:
type: object
x-examples:
example-1:
name: Get Users
definition: user definition
sql: SELECT * FROM tickets.users
owner: [email protected]
title: Term
properties:
id:
type: string
name:
type: string
definition:
type: string
sql:
type: string
owner:
type: string
Column:
title: Column
type: object
properties:
id:
type: string
name:
type: string
owners:
type: array
items:
$ref: '#/components/schemas/Owner'
tags:
type: array
items:
$ref: '#/components/schemas/Collection'
x-tags:
- column
Owner:
title: Owner
type: object
properties:
id:
type: string
email:
type: string
format: email
Tag:
title: Tag
type: object
properties:
id:
type: string
x-tags:
- collection
User:
description: ''
type: object
x-examples:
example-1:
email: [email protected]
role: Admin
title: User
properties:
email:
type: string
minLength: 1
example: [email protected]
format: email
role:
type: string
enum:
- Admin
- Viewer
- Editor
required:
- email
- role
x-tags:
- user
securitySchemes:
secoda-api-key:
type: apiKey
in: header
description: get your API Key in the settings
name: Authorization
security:
- secoda-api-key: []