Skip to content

Commit 87c4a03

Browse files
ceviixxceviixx
committed
/me endpoint added
1 parent 2c469e7 commit 87c4a03

File tree

1 file changed

+351
-1
lines changed

1 file changed

+351
-1
lines changed

‎openapi/openapi.yaml‎

Lines changed: 351 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ externalDocs:
2020
tags:
2121
- name: Authentication
2222
description: TBD
23+
- name: My account
24+
description: TBD
2325
- name: Stats
2426
description: TBD
2527
- name: Sessions
@@ -157,6 +159,348 @@ paths:
157159
"400":
158160
description: TBD
159161

162+
/me:
163+
get:
164+
summary: My details
165+
tags:
166+
- My account
167+
description: TBD
168+
operationId: meDetails
169+
responses:
170+
'200':
171+
description: Success
172+
content:
173+
application/json:
174+
example:
175+
token: "Y2xvU2VjdXJlL2Rldl9rR2JYbTZxR1l4T3ZxQ2xkQXVpU2Eyb1lhdWV2bU9YQUd2ZFk4M1JXbWoyZlFzR0JtSm1zS1ZtRWtqUUNmQm5QbU5qZ2JjQnJmOG1mUjZPc1p0Z2hDaj09"
176+
shareToken: null
177+
user:
178+
id: "5f9c2d41-8b7a-4e21-92d3-1c4b7a9f2e60"
179+
username: "[email protected]"
180+
role: "user"
181+
createdAt: "2024-04-17T19:20:55.624Z"
182+
isAdmin: false
183+
schema:
184+
type: object
185+
properties:
186+
token:
187+
type: string
188+
description: TBD
189+
shareToken:
190+
type:
191+
- string
192+
- 'null'
193+
description: TBD
194+
user:
195+
type: object
196+
properties:
197+
id:
198+
type: string
199+
format: uuid
200+
description: TBD
201+
username:
202+
type: string
203+
description: LTBD
204+
role:
205+
type: string
206+
description: TBD
207+
enum: [admin, user]
208+
createdAt:
209+
type: string
210+
format: date-time
211+
isAdmin:
212+
type: boolean
213+
description: TBD
214+
'400':
215+
description: Bad request
216+
217+
/me/teams:
218+
get:
219+
summary: My teams
220+
tags:
221+
- My account
222+
description: TBD
223+
operationId: meTeams
224+
responses:
225+
'200':
226+
description: Success
227+
content:
228+
application/json:
229+
example:
230+
data:
231+
- id: "d7a2b1c3-4e5f-4879-9a1b-1c2d3e4f5a6b"
232+
name: "alpha-squad"
233+
accessCode: "team_Qw3Rt9LmXa7P2VzK"
234+
logoUrl: null
235+
createdAt: "2025-10-17T23:20:47.360Z"
236+
updatedAt: "2025-10-17T23:20:49.059Z"
237+
deletedAt: null
238+
members:
239+
- id: "11f9b2ad-6e3c-4a0e-8b0e-7c3b5a9e2d41"
240+
teamId: "d7a2b1c3-4e5f-4879-9a1b-1c2d3e4f5a6b"
241+
userId: "4a6e0b7d-8c21-4b6e-a2b1-5f9c0d3e2a74"
242+
role: "team-owner"
243+
createdAt: "2025-10-17T23:20:47.511Z"
244+
updatedAt: "2025-10-17T23:20:47.511Z"
245+
user:
246+
id: "4a6e0b7d-8c21-4b6e-a2b1-5f9c0d3e2a74"
247+
username: "[email protected]"
248+
_count:
249+
websites: 0
250+
members: 1
251+
252+
- id: "a3c5e7f9-2b41-4d6a-8e0f-1a2b3c4d5e6f"
253+
name: "beta-team"
254+
accessCode: "team_Hn8Ks4Md2Qp7Zt0L"
255+
logoUrl: null
256+
createdAt: "2025-10-17T23:11:47.302Z"
257+
updatedAt: "2025-10-17T23:11:47.302Z"
258+
deletedAt: null
259+
members:
260+
- id: "c9a7b6e5-d4c3-4b2a-9f18-0e2d3c4b5a6f"
261+
teamId: "a3c5e7f9-2b41-4d6a-8e0f-1a2b3c4d5e6f"
262+
userId: "7b2c1d0e-9a8f-4e6d-b3c2-a1f0e9d8c7b6"
263+
role: "team-owner"
264+
createdAt: "2025-10-17T23:11:47.456Z"
265+
updatedAt: "2025-10-17T23:11:47.456Z"
266+
user:
267+
id: "7b2c1d0e-9a8f-4e6d-b3c2-a1f0e9d8c7b6"
268+
username: "[email protected]"
269+
_count:
270+
websites: 0
271+
members: 1
272+
273+
- id: "f1e3d5c7-b9a2-4c6d-8e0f-1a2b3c4d5e70"
274+
name: "static-team"
275+
accessCode: "team_Rk5Mn2TpLZ55VvQa"
276+
logoUrl: null
277+
createdAt: "2025-10-17T21:20:22.585Z"
278+
updatedAt: "2025-10-17T21:20:22.585Z"
279+
deletedAt: null
280+
members:
281+
- id: "ab34cd56-7890-4123-9def-0a1b2c3d4e5f"
282+
teamId: "f1e3d5c7-b9a2-4c6d-8e0f-1a2b3c4d5e70"
283+
userId: "3c2b1a0f-9e8d-4c7b-8a6f-5e4d3c2b1a0f"
284+
role: "team-owner"
285+
createdAt: "2025-10-17T21:20:22.738Z"
286+
updatedAt: "2025-10-17T21:20:22.738Z"
287+
user:
288+
id: "3c2b1a0f-9e8d-4c7b-8a6f-5e4d3c2b1a0f"
289+
username: "[email protected]"
290+
_count:
291+
websites: 0
292+
members: 1
293+
count: 3
294+
page: 1
295+
pageSize: 20
296+
schema:
297+
type: object
298+
properties:
299+
data:
300+
type: array
301+
items:
302+
type: object
303+
properties:
304+
id:
305+
type: string
306+
format: uuid
307+
name:
308+
type: string
309+
accessCode:
310+
type: string
311+
minLength: 8
312+
maxLength: 64
313+
description: TBD
314+
logoUrl:
315+
type:
316+
- string
317+
- 'null'
318+
format: uri
319+
createdAt:
320+
type: string
321+
format: date-time
322+
updatedAt:
323+
type: string
324+
format: date-time
325+
deletedAt:
326+
type:
327+
- string
328+
- 'null'
329+
format: date-time
330+
members:
331+
type: array
332+
items:
333+
type: object
334+
properties:
335+
id:
336+
type: string
337+
format: uuid
338+
teamId:
339+
type: string
340+
format: uuid
341+
userId:
342+
type: string
343+
format: uuid
344+
role:
345+
type: string
346+
description: TBD
347+
enum: [team-owner, team-admin, team-member]
348+
createdAt:
349+
type: string
350+
format: date-time
351+
updatedAt:
352+
type: string
353+
format: date-time
354+
user:
355+
type: object
356+
properties:
357+
id:
358+
type: string
359+
format: uuid
360+
username:
361+
type: string
362+
minLength: 1
363+
description: TBD
364+
_count:
365+
type: object
366+
properties:
367+
websites:
368+
type: integer
369+
members:
370+
type: integer
371+
count:
372+
type: integer
373+
page:
374+
type: integer
375+
pageSize:
376+
type: integer
377+
'400':
378+
description: Bad request
379+
380+
/me/websites:
381+
get:
382+
summary: My websites
383+
tags:
384+
- My account
385+
description: TBD
386+
operationId: meWebsites
387+
responses:
388+
'200':
389+
description: Success
390+
content:
391+
application/json:
392+
example:
393+
data:
394+
- id: "0f3a2c5e-9bd8-4c1f-92f7-1a2b3c4d5e6f"
395+
name: "Staging"
396+
domain: "staging.example.net"
397+
shareId: null
398+
resetAt: null
399+
userId: "5a8e7d9c-1b2f-4a3d-8e9f-0123456789ab"
400+
teamId: null
401+
createdBy: "5a8e7d9c-1b2f-4a3d-8e9f-0123456789ab"
402+
createdAt: "2025-09-22T11:35:23.635Z"
403+
updatedAt: "2025-10-17T20:01:05.473Z"
404+
deletedAt: null
405+
user:
406+
username: "[email protected]"
407+
id: "5a8e7d9c-1b2f-4a3d-8e9f-0123456789ab"
408+
- id: "7c6b5a49-2e1d-4f3a-8b9c-d0e1f2a3b4c5"
409+
name: "Website Catalog"
410+
domain: "catalog.example.org"
411+
shareId: null
412+
resetAt: null
413+
userId: "b3c2a1f0-9e8d-4c7b-8a6f-5e4d3c2b1a0f"
414+
teamId: null
415+
createdBy: "b3c2a1f0-9e8d-4c7b-8a6f-5e4d3c2b1a0f"
416+
createdAt: "2024-10-12T20:41:22.152Z"
417+
updatedAt: "2025-05-24T13:33:05.745Z"
418+
deletedAt: null
419+
user:
420+
username: "[email protected]"
421+
id: "b3c2a1f0-9e8d-4c7b-8a6f-5e4d3c2b1a0f"
422+
count: 2
423+
page: 1
424+
pageSize: 20
425+
schema:
426+
type: object
427+
properties:
428+
data:
429+
type: array
430+
items:
431+
type: object
432+
properties:
433+
id:
434+
type: string
435+
format: uuid
436+
description: TBD
437+
name:
438+
type: string
439+
description: TBD
440+
domain:
441+
type: string
442+
description: TBD
443+
format: hostname
444+
shareId:
445+
type:
446+
- string
447+
- 'null'
448+
description: TBD
449+
resetAt:
450+
type:
451+
- string
452+
- 'null'
453+
format: date-time
454+
description: TBD
455+
userId:
456+
type: string
457+
format: uuid
458+
description: TBD
459+
teamId:
460+
type:
461+
- string
462+
- 'null'
463+
format: uuid
464+
description: TBD
465+
createdBy:
466+
type: string
467+
format: uuid
468+
description: TBD
469+
createdAt:
470+
type: string
471+
format: date-time
472+
description: TBD
473+
updatedAt:
474+
type: string
475+
format: date-time
476+
description: TBD
477+
deletedAt:
478+
type:
479+
- string
480+
- 'null'
481+
format: date-time
482+
description: TBD
483+
user:
484+
type: object
485+
properties:
486+
id:
487+
type: string
488+
format: uuid
489+
username:
490+
type: string
491+
description: TBD
492+
count:
493+
type: integer
494+
description: TBD
495+
page:
496+
type: integer
497+
description: TBD
498+
pageSize:
499+
type: integer
500+
description: TBD
501+
'400':
502+
description: Bad request
503+
160504
/websites/{id}/active:
161505
get:
162506
summary: Active
@@ -2400,7 +2744,7 @@ paths:
24002744
"400":
24012745
description: Bad request
24022746

2403-
/websites/{id}/segments/:cohort_id:
2747+
/websites/{id}/segments/{_id}:
24042748
get:
24052749
summary: Get details
24062750
tags:
@@ -2414,6 +2758,12 @@ paths:
24142758
schema:
24152759
type: string
24162760
description: TBD
2761+
- name: _id
2762+
in: path
2763+
required: true
2764+
schema:
2765+
type: string
2766+
description: TBD
24172767
responses:
24182768
"200":
24192769
description: TBD

0 commit comments

Comments
 (0)