@proxima-nexus/openapi 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +15 -0
- package/README.md +284 -0
- package/openapi.json +2262 -0
- package/openapi.yaml +1500 -0
- package/package.json +45 -0
package/openapi.yaml
ADDED
|
@@ -0,0 +1,1500 @@
|
|
|
1
|
+
openapi: 3.0.0
|
|
2
|
+
paths:
|
|
3
|
+
/user:
|
|
4
|
+
post:
|
|
5
|
+
operationId: UserController_create
|
|
6
|
+
summary: Create a user
|
|
7
|
+
parameters: []
|
|
8
|
+
requestBody:
|
|
9
|
+
required: true
|
|
10
|
+
content:
|
|
11
|
+
application/json:
|
|
12
|
+
schema:
|
|
13
|
+
$ref: '#/components/schemas/CreateUserDto'
|
|
14
|
+
responses:
|
|
15
|
+
'201':
|
|
16
|
+
description: Created user ID
|
|
17
|
+
content:
|
|
18
|
+
application/json:
|
|
19
|
+
schema:
|
|
20
|
+
$ref: '#/components/schemas/MutateUserResponseDto'
|
|
21
|
+
tags:
|
|
22
|
+
- user
|
|
23
|
+
security:
|
|
24
|
+
- api_key: []
|
|
25
|
+
get:
|
|
26
|
+
operationId: UserController_search
|
|
27
|
+
summary: Search users
|
|
28
|
+
parameters:
|
|
29
|
+
- name: displayName
|
|
30
|
+
required: false
|
|
31
|
+
in: query
|
|
32
|
+
description: Display name search (ILIKE)
|
|
33
|
+
schema:
|
|
34
|
+
example: Keyword
|
|
35
|
+
type: string
|
|
36
|
+
- name: latitude
|
|
37
|
+
required: false
|
|
38
|
+
in: query
|
|
39
|
+
description: Latitude for radius search
|
|
40
|
+
schema:
|
|
41
|
+
example: 40.7128
|
|
42
|
+
type: number
|
|
43
|
+
- name: longitude
|
|
44
|
+
required: false
|
|
45
|
+
in: query
|
|
46
|
+
description: Longitude for radius search
|
|
47
|
+
schema:
|
|
48
|
+
example: -74.006
|
|
49
|
+
type: number
|
|
50
|
+
- name: radius
|
|
51
|
+
required: false
|
|
52
|
+
in: query
|
|
53
|
+
description: Radius in meters for radius search
|
|
54
|
+
schema:
|
|
55
|
+
example: 5000
|
|
56
|
+
type: number
|
|
57
|
+
- name: minLatitude
|
|
58
|
+
required: false
|
|
59
|
+
in: query
|
|
60
|
+
description: Minimum latitude for bounding box
|
|
61
|
+
schema:
|
|
62
|
+
example: 40
|
|
63
|
+
type: number
|
|
64
|
+
- name: maxLatitude
|
|
65
|
+
required: false
|
|
66
|
+
in: query
|
|
67
|
+
description: Maximum latitude for bounding box
|
|
68
|
+
schema:
|
|
69
|
+
example: 41
|
|
70
|
+
type: number
|
|
71
|
+
- name: minLongitude
|
|
72
|
+
required: false
|
|
73
|
+
in: query
|
|
74
|
+
description: Minimum longitude for bounding box
|
|
75
|
+
schema:
|
|
76
|
+
example: -75
|
|
77
|
+
type: number
|
|
78
|
+
- name: maxLongitude
|
|
79
|
+
required: false
|
|
80
|
+
in: query
|
|
81
|
+
description: Maximum longitude for bounding box
|
|
82
|
+
schema:
|
|
83
|
+
example: -73
|
|
84
|
+
type: number
|
|
85
|
+
- name: limit
|
|
86
|
+
required: false
|
|
87
|
+
in: query
|
|
88
|
+
description: Limit results (1-1000)
|
|
89
|
+
schema:
|
|
90
|
+
example: 100
|
|
91
|
+
type: number
|
|
92
|
+
responses:
|
|
93
|
+
'200':
|
|
94
|
+
description: Users returned
|
|
95
|
+
content:
|
|
96
|
+
application/json:
|
|
97
|
+
schema:
|
|
98
|
+
type: array
|
|
99
|
+
items:
|
|
100
|
+
$ref: '#/components/schemas/UserDto'
|
|
101
|
+
tags:
|
|
102
|
+
- user
|
|
103
|
+
security:
|
|
104
|
+
- api_key: []
|
|
105
|
+
/user/{userId}:
|
|
106
|
+
get:
|
|
107
|
+
operationId: UserController_findOne
|
|
108
|
+
summary: Get a user by ID
|
|
109
|
+
parameters:
|
|
110
|
+
- name: userId
|
|
111
|
+
required: true
|
|
112
|
+
in: path
|
|
113
|
+
schema:
|
|
114
|
+
type: string
|
|
115
|
+
responses:
|
|
116
|
+
'200':
|
|
117
|
+
description: User returned
|
|
118
|
+
content:
|
|
119
|
+
application/json:
|
|
120
|
+
schema:
|
|
121
|
+
$ref: '#/components/schemas/UserDto'
|
|
122
|
+
tags:
|
|
123
|
+
- user
|
|
124
|
+
security:
|
|
125
|
+
- api_key: []
|
|
126
|
+
patch:
|
|
127
|
+
operationId: UserController_update
|
|
128
|
+
summary: Update a user
|
|
129
|
+
parameters:
|
|
130
|
+
- name: userId
|
|
131
|
+
required: true
|
|
132
|
+
in: path
|
|
133
|
+
schema:
|
|
134
|
+
type: string
|
|
135
|
+
requestBody:
|
|
136
|
+
required: true
|
|
137
|
+
content:
|
|
138
|
+
application/json:
|
|
139
|
+
schema:
|
|
140
|
+
$ref: '#/components/schemas/UpdateUserDto'
|
|
141
|
+
responses:
|
|
142
|
+
'200':
|
|
143
|
+
description: Updated user ID
|
|
144
|
+
content:
|
|
145
|
+
application/json:
|
|
146
|
+
schema:
|
|
147
|
+
$ref: '#/components/schemas/MutateUserResponseDto'
|
|
148
|
+
tags:
|
|
149
|
+
- user
|
|
150
|
+
security:
|
|
151
|
+
- api_key: []
|
|
152
|
+
delete:
|
|
153
|
+
operationId: UserController_remove
|
|
154
|
+
summary: Delete a user
|
|
155
|
+
parameters:
|
|
156
|
+
- name: userId
|
|
157
|
+
required: true
|
|
158
|
+
in: path
|
|
159
|
+
schema:
|
|
160
|
+
type: string
|
|
161
|
+
responses:
|
|
162
|
+
'204':
|
|
163
|
+
description: User deleted
|
|
164
|
+
tags:
|
|
165
|
+
- user
|
|
166
|
+
security:
|
|
167
|
+
- api_key: []
|
|
168
|
+
/user/{userId}/friends/{friendUserId}:
|
|
169
|
+
put:
|
|
170
|
+
operationId: UserController_addFriend
|
|
171
|
+
summary: Add a friend to a user
|
|
172
|
+
parameters:
|
|
173
|
+
- name: userId
|
|
174
|
+
required: true
|
|
175
|
+
in: path
|
|
176
|
+
schema:
|
|
177
|
+
type: string
|
|
178
|
+
- name: friendUserId
|
|
179
|
+
required: true
|
|
180
|
+
in: path
|
|
181
|
+
schema:
|
|
182
|
+
type: string
|
|
183
|
+
responses:
|
|
184
|
+
'200':
|
|
185
|
+
description: Friend added
|
|
186
|
+
content:
|
|
187
|
+
application/json:
|
|
188
|
+
schema:
|
|
189
|
+
$ref: '#/components/schemas/EntityConnectionDto'
|
|
190
|
+
tags:
|
|
191
|
+
- user
|
|
192
|
+
security:
|
|
193
|
+
- api_key: []
|
|
194
|
+
delete:
|
|
195
|
+
operationId: UserController_removeFriend
|
|
196
|
+
summary: Remove a friend from a user
|
|
197
|
+
parameters:
|
|
198
|
+
- name: userId
|
|
199
|
+
required: true
|
|
200
|
+
in: path
|
|
201
|
+
schema:
|
|
202
|
+
type: string
|
|
203
|
+
- name: friendUserId
|
|
204
|
+
required: true
|
|
205
|
+
in: path
|
|
206
|
+
schema:
|
|
207
|
+
type: string
|
|
208
|
+
responses:
|
|
209
|
+
'200':
|
|
210
|
+
description: Friend removed
|
|
211
|
+
tags:
|
|
212
|
+
- user
|
|
213
|
+
security:
|
|
214
|
+
- api_key: []
|
|
215
|
+
/user/{userId}/friends:
|
|
216
|
+
get:
|
|
217
|
+
operationId: UserController_getFriends
|
|
218
|
+
summary: Get friends of a user
|
|
219
|
+
parameters:
|
|
220
|
+
- name: userId
|
|
221
|
+
required: true
|
|
222
|
+
in: path
|
|
223
|
+
schema:
|
|
224
|
+
type: string
|
|
225
|
+
responses:
|
|
226
|
+
'200':
|
|
227
|
+
description: Friends returned
|
|
228
|
+
content:
|
|
229
|
+
application/json:
|
|
230
|
+
schema:
|
|
231
|
+
type: array
|
|
232
|
+
items:
|
|
233
|
+
$ref: '#/components/schemas/UserEntityConnectionDto'
|
|
234
|
+
tags:
|
|
235
|
+
- user
|
|
236
|
+
security:
|
|
237
|
+
- api_key: []
|
|
238
|
+
/user/batch:
|
|
239
|
+
post:
|
|
240
|
+
operationId: UserController_getBatch
|
|
241
|
+
summary: Get a batch of users by IDs
|
|
242
|
+
parameters: []
|
|
243
|
+
requestBody:
|
|
244
|
+
required: true
|
|
245
|
+
content:
|
|
246
|
+
application/json:
|
|
247
|
+
schema:
|
|
248
|
+
$ref: '#/components/schemas/GetUsersDto'
|
|
249
|
+
responses:
|
|
250
|
+
'200':
|
|
251
|
+
description: Users returned
|
|
252
|
+
content:
|
|
253
|
+
application/json:
|
|
254
|
+
schema:
|
|
255
|
+
type: array
|
|
256
|
+
items:
|
|
257
|
+
$ref: '#/components/schemas/UserDto'
|
|
258
|
+
tags:
|
|
259
|
+
- user
|
|
260
|
+
security:
|
|
261
|
+
- api_key: []
|
|
262
|
+
/user/{userId}/groups:
|
|
263
|
+
get:
|
|
264
|
+
operationId: UserController_getGroups
|
|
265
|
+
summary: Get groups of a user
|
|
266
|
+
parameters:
|
|
267
|
+
- name: userId
|
|
268
|
+
required: true
|
|
269
|
+
in: path
|
|
270
|
+
schema:
|
|
271
|
+
type: string
|
|
272
|
+
responses:
|
|
273
|
+
'200':
|
|
274
|
+
description: Groups returned
|
|
275
|
+
content:
|
|
276
|
+
application/json:
|
|
277
|
+
schema:
|
|
278
|
+
type: array
|
|
279
|
+
items:
|
|
280
|
+
$ref: '#/components/schemas/GroupEntityConnectionDto'
|
|
281
|
+
tags:
|
|
282
|
+
- user
|
|
283
|
+
security:
|
|
284
|
+
- api_key: []
|
|
285
|
+
/user/{userId}/events:
|
|
286
|
+
get:
|
|
287
|
+
operationId: UserController_getEvents
|
|
288
|
+
summary: Get events of a user
|
|
289
|
+
parameters:
|
|
290
|
+
- name: userId
|
|
291
|
+
required: true
|
|
292
|
+
in: path
|
|
293
|
+
schema:
|
|
294
|
+
type: string
|
|
295
|
+
responses:
|
|
296
|
+
'200':
|
|
297
|
+
description: Events returned
|
|
298
|
+
content:
|
|
299
|
+
application/json:
|
|
300
|
+
schema:
|
|
301
|
+
type: array
|
|
302
|
+
items:
|
|
303
|
+
$ref: '#/components/schemas/EventEntityConnectionDto'
|
|
304
|
+
tags:
|
|
305
|
+
- user
|
|
306
|
+
security:
|
|
307
|
+
- api_key: []
|
|
308
|
+
/event:
|
|
309
|
+
post:
|
|
310
|
+
operationId: EventController_create
|
|
311
|
+
summary: Create an event
|
|
312
|
+
parameters: []
|
|
313
|
+
requestBody:
|
|
314
|
+
required: true
|
|
315
|
+
content:
|
|
316
|
+
application/json:
|
|
317
|
+
schema:
|
|
318
|
+
$ref: '#/components/schemas/CreateEventDto'
|
|
319
|
+
responses:
|
|
320
|
+
'201':
|
|
321
|
+
description: Created event ID
|
|
322
|
+
content:
|
|
323
|
+
application/json:
|
|
324
|
+
schema:
|
|
325
|
+
type: string
|
|
326
|
+
tags:
|
|
327
|
+
- event
|
|
328
|
+
security:
|
|
329
|
+
- bearer: []
|
|
330
|
+
get:
|
|
331
|
+
operationId: EventController_search
|
|
332
|
+
summary: Search events
|
|
333
|
+
parameters:
|
|
334
|
+
- name: displayName
|
|
335
|
+
required: false
|
|
336
|
+
in: query
|
|
337
|
+
description: Display name search (ILIKE)
|
|
338
|
+
schema:
|
|
339
|
+
example: Keyword
|
|
340
|
+
type: string
|
|
341
|
+
- name: latitude
|
|
342
|
+
required: false
|
|
343
|
+
in: query
|
|
344
|
+
description: Latitude for radius search
|
|
345
|
+
schema:
|
|
346
|
+
example: 40.7128
|
|
347
|
+
type: number
|
|
348
|
+
- name: longitude
|
|
349
|
+
required: false
|
|
350
|
+
in: query
|
|
351
|
+
description: Longitude for radius search
|
|
352
|
+
schema:
|
|
353
|
+
example: -74.006
|
|
354
|
+
type: number
|
|
355
|
+
- name: radius
|
|
356
|
+
required: false
|
|
357
|
+
in: query
|
|
358
|
+
description: Radius in meters for radius search
|
|
359
|
+
schema:
|
|
360
|
+
example: 5000
|
|
361
|
+
type: number
|
|
362
|
+
- name: minLatitude
|
|
363
|
+
required: false
|
|
364
|
+
in: query
|
|
365
|
+
description: Minimum latitude for bounding box
|
|
366
|
+
schema:
|
|
367
|
+
example: 40
|
|
368
|
+
type: number
|
|
369
|
+
- name: maxLatitude
|
|
370
|
+
required: false
|
|
371
|
+
in: query
|
|
372
|
+
description: Maximum latitude for bounding box
|
|
373
|
+
schema:
|
|
374
|
+
example: 41
|
|
375
|
+
type: number
|
|
376
|
+
- name: minLongitude
|
|
377
|
+
required: false
|
|
378
|
+
in: query
|
|
379
|
+
description: Minimum longitude for bounding box
|
|
380
|
+
schema:
|
|
381
|
+
example: -75
|
|
382
|
+
type: number
|
|
383
|
+
- name: maxLongitude
|
|
384
|
+
required: false
|
|
385
|
+
in: query
|
|
386
|
+
description: Maximum longitude for bounding box
|
|
387
|
+
schema:
|
|
388
|
+
example: -73
|
|
389
|
+
type: number
|
|
390
|
+
- name: limit
|
|
391
|
+
required: false
|
|
392
|
+
in: query
|
|
393
|
+
description: Limit results (1-1000)
|
|
394
|
+
schema:
|
|
395
|
+
example: 100
|
|
396
|
+
type: number
|
|
397
|
+
responses:
|
|
398
|
+
'200':
|
|
399
|
+
description: Events returned
|
|
400
|
+
content:
|
|
401
|
+
application/json:
|
|
402
|
+
schema:
|
|
403
|
+
type: array
|
|
404
|
+
items:
|
|
405
|
+
$ref: '#/components/schemas/EventDto'
|
|
406
|
+
tags:
|
|
407
|
+
- event
|
|
408
|
+
security:
|
|
409
|
+
- bearer: []
|
|
410
|
+
/event/{eventId}:
|
|
411
|
+
get:
|
|
412
|
+
operationId: EventController_findOne
|
|
413
|
+
summary: Get an event by ID
|
|
414
|
+
parameters:
|
|
415
|
+
- name: eventId
|
|
416
|
+
required: true
|
|
417
|
+
in: path
|
|
418
|
+
schema:
|
|
419
|
+
type: string
|
|
420
|
+
responses:
|
|
421
|
+
'200':
|
|
422
|
+
description: Event returned
|
|
423
|
+
content:
|
|
424
|
+
application/json:
|
|
425
|
+
schema:
|
|
426
|
+
$ref: '#/components/schemas/EventDto'
|
|
427
|
+
tags:
|
|
428
|
+
- event
|
|
429
|
+
security:
|
|
430
|
+
- bearer: []
|
|
431
|
+
put:
|
|
432
|
+
operationId: EventController_update
|
|
433
|
+
summary: Update an event
|
|
434
|
+
parameters:
|
|
435
|
+
- name: eventId
|
|
436
|
+
required: true
|
|
437
|
+
in: path
|
|
438
|
+
schema:
|
|
439
|
+
type: string
|
|
440
|
+
requestBody:
|
|
441
|
+
required: true
|
|
442
|
+
content:
|
|
443
|
+
application/json:
|
|
444
|
+
schema:
|
|
445
|
+
$ref: '#/components/schemas/UpdateEventDto'
|
|
446
|
+
responses:
|
|
447
|
+
'200':
|
|
448
|
+
description: Updated event ID
|
|
449
|
+
content:
|
|
450
|
+
application/json:
|
|
451
|
+
schema:
|
|
452
|
+
type: string
|
|
453
|
+
tags:
|
|
454
|
+
- event
|
|
455
|
+
security:
|
|
456
|
+
- bearer: []
|
|
457
|
+
delete:
|
|
458
|
+
operationId: EventController_remove
|
|
459
|
+
summary: Delete an event
|
|
460
|
+
parameters:
|
|
461
|
+
- name: eventId
|
|
462
|
+
required: true
|
|
463
|
+
in: path
|
|
464
|
+
schema:
|
|
465
|
+
type: string
|
|
466
|
+
- name: X-Proxima-Nexus-Requester-User-Id
|
|
467
|
+
in: header
|
|
468
|
+
description: Requester user ID
|
|
469
|
+
required: true
|
|
470
|
+
schema:
|
|
471
|
+
type: string
|
|
472
|
+
responses:
|
|
473
|
+
'204':
|
|
474
|
+
description: Event deleted
|
|
475
|
+
tags:
|
|
476
|
+
- event
|
|
477
|
+
security:
|
|
478
|
+
- bearer: []
|
|
479
|
+
/event/{eventId}/attendees/{userId}:
|
|
480
|
+
put:
|
|
481
|
+
operationId: EventController_addAttendee
|
|
482
|
+
summary: Add an attendee to an event
|
|
483
|
+
parameters:
|
|
484
|
+
- name: eventId
|
|
485
|
+
required: true
|
|
486
|
+
in: path
|
|
487
|
+
schema:
|
|
488
|
+
type: string
|
|
489
|
+
- name: userId
|
|
490
|
+
required: true
|
|
491
|
+
in: path
|
|
492
|
+
schema:
|
|
493
|
+
type: string
|
|
494
|
+
responses:
|
|
495
|
+
'200':
|
|
496
|
+
description: Attendee added
|
|
497
|
+
content:
|
|
498
|
+
application/json:
|
|
499
|
+
schema:
|
|
500
|
+
$ref: '#/components/schemas/EntityConnectionDto'
|
|
501
|
+
tags:
|
|
502
|
+
- event
|
|
503
|
+
security:
|
|
504
|
+
- bearer: []
|
|
505
|
+
/event/{eventId}/attendees:
|
|
506
|
+
get:
|
|
507
|
+
operationId: EventController_getAttendees
|
|
508
|
+
summary: Get attendees of an event
|
|
509
|
+
parameters:
|
|
510
|
+
- name: eventId
|
|
511
|
+
required: true
|
|
512
|
+
in: path
|
|
513
|
+
schema:
|
|
514
|
+
type: string
|
|
515
|
+
responses:
|
|
516
|
+
'200':
|
|
517
|
+
description: Attendees returned
|
|
518
|
+
content:
|
|
519
|
+
application/json:
|
|
520
|
+
schema:
|
|
521
|
+
type: array
|
|
522
|
+
items:
|
|
523
|
+
$ref: '#/components/schemas/UserEntityConnectionDto'
|
|
524
|
+
tags:
|
|
525
|
+
- event
|
|
526
|
+
security:
|
|
527
|
+
- bearer: []
|
|
528
|
+
/event/batch:
|
|
529
|
+
post:
|
|
530
|
+
operationId: EventController_getBatch
|
|
531
|
+
summary: Get a batch of events by IDs
|
|
532
|
+
parameters: []
|
|
533
|
+
requestBody:
|
|
534
|
+
required: true
|
|
535
|
+
content:
|
|
536
|
+
application/json:
|
|
537
|
+
schema:
|
|
538
|
+
$ref: '#/components/schemas/GetEventsDto'
|
|
539
|
+
responses:
|
|
540
|
+
'200':
|
|
541
|
+
description: Events returned
|
|
542
|
+
content:
|
|
543
|
+
application/json:
|
|
544
|
+
schema:
|
|
545
|
+
type: array
|
|
546
|
+
items:
|
|
547
|
+
$ref: '#/components/schemas/EventDto'
|
|
548
|
+
tags:
|
|
549
|
+
- event
|
|
550
|
+
security:
|
|
551
|
+
- bearer: []
|
|
552
|
+
/group:
|
|
553
|
+
post:
|
|
554
|
+
operationId: GroupController_create
|
|
555
|
+
summary: Create a group
|
|
556
|
+
parameters: []
|
|
557
|
+
requestBody:
|
|
558
|
+
required: true
|
|
559
|
+
content:
|
|
560
|
+
application/json:
|
|
561
|
+
schema:
|
|
562
|
+
$ref: '#/components/schemas/CreateGroupDto'
|
|
563
|
+
responses:
|
|
564
|
+
'201':
|
|
565
|
+
description: Created group ID
|
|
566
|
+
content:
|
|
567
|
+
application/json:
|
|
568
|
+
schema:
|
|
569
|
+
type: string
|
|
570
|
+
tags:
|
|
571
|
+
- group
|
|
572
|
+
security:
|
|
573
|
+
- bearer: []
|
|
574
|
+
get:
|
|
575
|
+
operationId: GroupController_search
|
|
576
|
+
summary: Search groups
|
|
577
|
+
parameters:
|
|
578
|
+
- name: displayName
|
|
579
|
+
required: false
|
|
580
|
+
in: query
|
|
581
|
+
description: Display name search (ILIKE)
|
|
582
|
+
schema:
|
|
583
|
+
example: Keyword
|
|
584
|
+
type: string
|
|
585
|
+
- name: latitude
|
|
586
|
+
required: false
|
|
587
|
+
in: query
|
|
588
|
+
description: Latitude for radius search
|
|
589
|
+
schema:
|
|
590
|
+
example: 40.7128
|
|
591
|
+
type: number
|
|
592
|
+
- name: longitude
|
|
593
|
+
required: false
|
|
594
|
+
in: query
|
|
595
|
+
description: Longitude for radius search
|
|
596
|
+
schema:
|
|
597
|
+
example: -74.006
|
|
598
|
+
type: number
|
|
599
|
+
- name: radius
|
|
600
|
+
required: false
|
|
601
|
+
in: query
|
|
602
|
+
description: Radius in meters for radius search
|
|
603
|
+
schema:
|
|
604
|
+
example: 5000
|
|
605
|
+
type: number
|
|
606
|
+
- name: minLatitude
|
|
607
|
+
required: false
|
|
608
|
+
in: query
|
|
609
|
+
description: Minimum latitude for bounding box
|
|
610
|
+
schema:
|
|
611
|
+
example: 40
|
|
612
|
+
type: number
|
|
613
|
+
- name: maxLatitude
|
|
614
|
+
required: false
|
|
615
|
+
in: query
|
|
616
|
+
description: Maximum latitude for bounding box
|
|
617
|
+
schema:
|
|
618
|
+
example: 41
|
|
619
|
+
type: number
|
|
620
|
+
- name: minLongitude
|
|
621
|
+
required: false
|
|
622
|
+
in: query
|
|
623
|
+
description: Minimum longitude for bounding box
|
|
624
|
+
schema:
|
|
625
|
+
example: -75
|
|
626
|
+
type: number
|
|
627
|
+
- name: maxLongitude
|
|
628
|
+
required: false
|
|
629
|
+
in: query
|
|
630
|
+
description: Maximum longitude for bounding box
|
|
631
|
+
schema:
|
|
632
|
+
example: -73
|
|
633
|
+
type: number
|
|
634
|
+
- name: limit
|
|
635
|
+
required: false
|
|
636
|
+
in: query
|
|
637
|
+
description: Limit results (1-1000)
|
|
638
|
+
schema:
|
|
639
|
+
example: 100
|
|
640
|
+
type: number
|
|
641
|
+
responses:
|
|
642
|
+
'200':
|
|
643
|
+
description: Groups returned
|
|
644
|
+
content:
|
|
645
|
+
application/json:
|
|
646
|
+
schema:
|
|
647
|
+
type: array
|
|
648
|
+
items:
|
|
649
|
+
$ref: '#/components/schemas/GroupDto'
|
|
650
|
+
tags:
|
|
651
|
+
- group
|
|
652
|
+
security:
|
|
653
|
+
- bearer: []
|
|
654
|
+
/group/{groupId}:
|
|
655
|
+
get:
|
|
656
|
+
operationId: GroupController_findOne
|
|
657
|
+
summary: Get a group by ID
|
|
658
|
+
parameters:
|
|
659
|
+
- name: groupId
|
|
660
|
+
required: true
|
|
661
|
+
in: path
|
|
662
|
+
schema:
|
|
663
|
+
type: string
|
|
664
|
+
responses:
|
|
665
|
+
'200':
|
|
666
|
+
description: Group returned
|
|
667
|
+
content:
|
|
668
|
+
application/json:
|
|
669
|
+
schema:
|
|
670
|
+
$ref: '#/components/schemas/GroupDto'
|
|
671
|
+
tags:
|
|
672
|
+
- group
|
|
673
|
+
security:
|
|
674
|
+
- bearer: []
|
|
675
|
+
patch:
|
|
676
|
+
operationId: GroupController_update
|
|
677
|
+
summary: Update a group
|
|
678
|
+
parameters:
|
|
679
|
+
- name: groupId
|
|
680
|
+
required: true
|
|
681
|
+
in: path
|
|
682
|
+
schema:
|
|
683
|
+
type: string
|
|
684
|
+
requestBody:
|
|
685
|
+
required: true
|
|
686
|
+
content:
|
|
687
|
+
application/json:
|
|
688
|
+
schema:
|
|
689
|
+
$ref: '#/components/schemas/UpdateGroupDto'
|
|
690
|
+
responses:
|
|
691
|
+
'200':
|
|
692
|
+
description: Updated group ID
|
|
693
|
+
content:
|
|
694
|
+
application/json:
|
|
695
|
+
schema:
|
|
696
|
+
type: string
|
|
697
|
+
tags:
|
|
698
|
+
- group
|
|
699
|
+
security:
|
|
700
|
+
- bearer: []
|
|
701
|
+
delete:
|
|
702
|
+
operationId: GroupController_remove
|
|
703
|
+
summary: Delete a group
|
|
704
|
+
parameters:
|
|
705
|
+
- name: groupId
|
|
706
|
+
required: true
|
|
707
|
+
in: path
|
|
708
|
+
schema:
|
|
709
|
+
type: string
|
|
710
|
+
- name: X-Proxima-Nexus-Requester-User-Id
|
|
711
|
+
in: header
|
|
712
|
+
description: Requester user ID
|
|
713
|
+
required: true
|
|
714
|
+
schema:
|
|
715
|
+
type: string
|
|
716
|
+
responses:
|
|
717
|
+
'204':
|
|
718
|
+
description: Group deleted
|
|
719
|
+
tags:
|
|
720
|
+
- group
|
|
721
|
+
security:
|
|
722
|
+
- bearer: []
|
|
723
|
+
/group/{groupId}/members/{userId}:
|
|
724
|
+
put:
|
|
725
|
+
operationId: GroupController_addMember
|
|
726
|
+
summary: Add a member to a group
|
|
727
|
+
parameters:
|
|
728
|
+
- name: groupId
|
|
729
|
+
required: true
|
|
730
|
+
in: path
|
|
731
|
+
schema:
|
|
732
|
+
type: string
|
|
733
|
+
- name: userId
|
|
734
|
+
required: true
|
|
735
|
+
in: path
|
|
736
|
+
schema:
|
|
737
|
+
type: string
|
|
738
|
+
responses:
|
|
739
|
+
'200':
|
|
740
|
+
description: Member added
|
|
741
|
+
content:
|
|
742
|
+
application/json:
|
|
743
|
+
schema:
|
|
744
|
+
$ref: '#/components/schemas/EntityConnectionDto'
|
|
745
|
+
tags:
|
|
746
|
+
- group
|
|
747
|
+
security:
|
|
748
|
+
- bearer: []
|
|
749
|
+
delete:
|
|
750
|
+
operationId: GroupController_removeMember
|
|
751
|
+
summary: Remove a member from a group
|
|
752
|
+
parameters:
|
|
753
|
+
- name: groupId
|
|
754
|
+
required: true
|
|
755
|
+
in: path
|
|
756
|
+
schema:
|
|
757
|
+
type: string
|
|
758
|
+
- name: userId
|
|
759
|
+
required: true
|
|
760
|
+
in: path
|
|
761
|
+
schema:
|
|
762
|
+
type: string
|
|
763
|
+
responses:
|
|
764
|
+
'200':
|
|
765
|
+
description: Member removed
|
|
766
|
+
content:
|
|
767
|
+
application/json:
|
|
768
|
+
schema:
|
|
769
|
+
type: string
|
|
770
|
+
tags:
|
|
771
|
+
- group
|
|
772
|
+
security:
|
|
773
|
+
- bearer: []
|
|
774
|
+
/group/{groupId}/members:
|
|
775
|
+
get:
|
|
776
|
+
operationId: GroupController_getMembers
|
|
777
|
+
summary: Get members of a group
|
|
778
|
+
parameters:
|
|
779
|
+
- name: groupId
|
|
780
|
+
required: true
|
|
781
|
+
in: path
|
|
782
|
+
schema:
|
|
783
|
+
type: string
|
|
784
|
+
responses:
|
|
785
|
+
'200':
|
|
786
|
+
description: Members returned
|
|
787
|
+
content:
|
|
788
|
+
application/json:
|
|
789
|
+
schema:
|
|
790
|
+
type: array
|
|
791
|
+
items:
|
|
792
|
+
$ref: '#/components/schemas/UserEntityConnectionDto'
|
|
793
|
+
tags:
|
|
794
|
+
- group
|
|
795
|
+
security:
|
|
796
|
+
- bearer: []
|
|
797
|
+
/group/{groupId}/events:
|
|
798
|
+
get:
|
|
799
|
+
operationId: GroupController_getEvents
|
|
800
|
+
summary: Get events of a group
|
|
801
|
+
parameters:
|
|
802
|
+
- name: groupId
|
|
803
|
+
required: true
|
|
804
|
+
in: path
|
|
805
|
+
schema:
|
|
806
|
+
type: string
|
|
807
|
+
responses:
|
|
808
|
+
'200':
|
|
809
|
+
description: Events returned
|
|
810
|
+
content:
|
|
811
|
+
application/json:
|
|
812
|
+
schema:
|
|
813
|
+
type: array
|
|
814
|
+
items:
|
|
815
|
+
$ref: '#/components/schemas/EventEntityConnectionDto'
|
|
816
|
+
tags:
|
|
817
|
+
- group
|
|
818
|
+
security:
|
|
819
|
+
- bearer: []
|
|
820
|
+
/group/batch:
|
|
821
|
+
post:
|
|
822
|
+
operationId: GroupController_getBatch
|
|
823
|
+
summary: Get a batch of groups by IDs
|
|
824
|
+
parameters: []
|
|
825
|
+
requestBody:
|
|
826
|
+
required: true
|
|
827
|
+
content:
|
|
828
|
+
application/json:
|
|
829
|
+
schema:
|
|
830
|
+
$ref: '#/components/schemas/GetGroupsDto'
|
|
831
|
+
responses:
|
|
832
|
+
'200':
|
|
833
|
+
description: Groups returned
|
|
834
|
+
content:
|
|
835
|
+
application/json:
|
|
836
|
+
schema:
|
|
837
|
+
type: array
|
|
838
|
+
items:
|
|
839
|
+
$ref: '#/components/schemas/GroupDto'
|
|
840
|
+
tags:
|
|
841
|
+
- group
|
|
842
|
+
security:
|
|
843
|
+
- bearer: []
|
|
844
|
+
info:
|
|
845
|
+
title: proxima-nexus-data-plane-api
|
|
846
|
+
description: Proxima Nexus Data Plane API
|
|
847
|
+
version: 1.0.0
|
|
848
|
+
contact: {}
|
|
849
|
+
tags: []
|
|
850
|
+
servers: []
|
|
851
|
+
components:
|
|
852
|
+
securitySchemes:
|
|
853
|
+
api_key:
|
|
854
|
+
type: apiKey
|
|
855
|
+
in: header
|
|
856
|
+
name: X-Proxima-Nexus-Api-Key
|
|
857
|
+
schemas:
|
|
858
|
+
LocationDto:
|
|
859
|
+
type: object
|
|
860
|
+
properties:
|
|
861
|
+
latitude:
|
|
862
|
+
type: number
|
|
863
|
+
description: Latitude in decimal degrees
|
|
864
|
+
example: 40.7128
|
|
865
|
+
longitude:
|
|
866
|
+
type: number
|
|
867
|
+
description: Longitude in decimal degrees
|
|
868
|
+
example: -74.006
|
|
869
|
+
name:
|
|
870
|
+
type: string
|
|
871
|
+
description: Human-readable location name
|
|
872
|
+
example: New York, NY
|
|
873
|
+
CreateUserDto:
|
|
874
|
+
type: object
|
|
875
|
+
properties:
|
|
876
|
+
displayName:
|
|
877
|
+
type: string
|
|
878
|
+
description: Display name
|
|
879
|
+
example: Display Name
|
|
880
|
+
requesterUserId:
|
|
881
|
+
type: string
|
|
882
|
+
description: User ID of the requester
|
|
883
|
+
example: user-123
|
|
884
|
+
visibility:
|
|
885
|
+
type: string
|
|
886
|
+
description: Visibility of the entity
|
|
887
|
+
enum:
|
|
888
|
+
- public
|
|
889
|
+
- connections
|
|
890
|
+
- hidden
|
|
891
|
+
example: public
|
|
892
|
+
location:
|
|
893
|
+
description: Optional location information
|
|
894
|
+
allOf:
|
|
895
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
896
|
+
description:
|
|
897
|
+
type: string
|
|
898
|
+
description: Entity description
|
|
899
|
+
example: A description of the entity
|
|
900
|
+
tags:
|
|
901
|
+
description: Entity tags
|
|
902
|
+
example:
|
|
903
|
+
- tag1
|
|
904
|
+
- tag2
|
|
905
|
+
type: array
|
|
906
|
+
items:
|
|
907
|
+
type: string
|
|
908
|
+
userId:
|
|
909
|
+
type: string
|
|
910
|
+
description: Unique user identifier
|
|
911
|
+
example: user-123
|
|
912
|
+
gender:
|
|
913
|
+
type: string
|
|
914
|
+
description: Gender
|
|
915
|
+
example: female
|
|
916
|
+
birthDate:
|
|
917
|
+
type: string
|
|
918
|
+
description: Birth date (ISO 8601)
|
|
919
|
+
example: '1990-01-01'
|
|
920
|
+
required:
|
|
921
|
+
- displayName
|
|
922
|
+
- requesterUserId
|
|
923
|
+
- visibility
|
|
924
|
+
- userId
|
|
925
|
+
- gender
|
|
926
|
+
- birthDate
|
|
927
|
+
MutateUserResponseDto:
|
|
928
|
+
type: object
|
|
929
|
+
properties:
|
|
930
|
+
userId:
|
|
931
|
+
type: string
|
|
932
|
+
description: User ID
|
|
933
|
+
example: user-123
|
|
934
|
+
required:
|
|
935
|
+
- userId
|
|
936
|
+
UserDto:
|
|
937
|
+
type: object
|
|
938
|
+
properties:
|
|
939
|
+
entityId:
|
|
940
|
+
type: string
|
|
941
|
+
description: Unique identifier for the entity
|
|
942
|
+
example: entity-123
|
|
943
|
+
tenantId:
|
|
944
|
+
type: string
|
|
945
|
+
description: Tenant identifier the entity belongs to
|
|
946
|
+
example: tenant-abc
|
|
947
|
+
displayName:
|
|
948
|
+
type: string
|
|
949
|
+
description: Display name of the entity
|
|
950
|
+
example: Sample Entity
|
|
951
|
+
visibility:
|
|
952
|
+
type: string
|
|
953
|
+
description: Visibility of the entity
|
|
954
|
+
enum:
|
|
955
|
+
- PUBLIC
|
|
956
|
+
- PRIVATE
|
|
957
|
+
example: PUBLIC
|
|
958
|
+
description:
|
|
959
|
+
type: string
|
|
960
|
+
description: Description of the entity
|
|
961
|
+
example: A description of the entity
|
|
962
|
+
tags:
|
|
963
|
+
description: Tags associated with the entity
|
|
964
|
+
example:
|
|
965
|
+
- tag1
|
|
966
|
+
- tag2
|
|
967
|
+
type: array
|
|
968
|
+
items:
|
|
969
|
+
type: string
|
|
970
|
+
createdAt:
|
|
971
|
+
type: string
|
|
972
|
+
description: Date/time the entity was created (ISO string)
|
|
973
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
974
|
+
updatedAt:
|
|
975
|
+
type: string
|
|
976
|
+
description: Date/time the entity was last updated (ISO string)
|
|
977
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
978
|
+
location:
|
|
979
|
+
description: Required location information
|
|
980
|
+
allOf:
|
|
981
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
982
|
+
gender:
|
|
983
|
+
type: string
|
|
984
|
+
description: Gender
|
|
985
|
+
example: female
|
|
986
|
+
birthDate:
|
|
987
|
+
type: string
|
|
988
|
+
description: Birth date (ISO 8601)
|
|
989
|
+
example: '1990-01-01'
|
|
990
|
+
required:
|
|
991
|
+
- gender
|
|
992
|
+
- birthDate
|
|
993
|
+
UpdateUserDto:
|
|
994
|
+
type: object
|
|
995
|
+
properties:
|
|
996
|
+
requesterUserId:
|
|
997
|
+
type: string
|
|
998
|
+
description: User ID of the requester
|
|
999
|
+
example: user-123
|
|
1000
|
+
visibility:
|
|
1001
|
+
type: string
|
|
1002
|
+
description: Visibility of the entity
|
|
1003
|
+
enum:
|
|
1004
|
+
- public
|
|
1005
|
+
- connections
|
|
1006
|
+
- hidden
|
|
1007
|
+
example: public
|
|
1008
|
+
displayName:
|
|
1009
|
+
type: string
|
|
1010
|
+
description: Display name
|
|
1011
|
+
example: Display Name
|
|
1012
|
+
location:
|
|
1013
|
+
description: Optional location information
|
|
1014
|
+
allOf:
|
|
1015
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1016
|
+
description:
|
|
1017
|
+
type: string
|
|
1018
|
+
description: Entity description
|
|
1019
|
+
example: A description of the entity
|
|
1020
|
+
tags:
|
|
1021
|
+
description: Entity tags
|
|
1022
|
+
example:
|
|
1023
|
+
- tag1
|
|
1024
|
+
- tag2
|
|
1025
|
+
type: array
|
|
1026
|
+
items:
|
|
1027
|
+
type: string
|
|
1028
|
+
gender:
|
|
1029
|
+
type: string
|
|
1030
|
+
description: Gender
|
|
1031
|
+
example: female
|
|
1032
|
+
birthDate:
|
|
1033
|
+
type: string
|
|
1034
|
+
description: Birth date (ISO 8601)
|
|
1035
|
+
example: '1990-01-01'
|
|
1036
|
+
required:
|
|
1037
|
+
- requesterUserId
|
|
1038
|
+
- displayName
|
|
1039
|
+
- gender
|
|
1040
|
+
- birthDate
|
|
1041
|
+
EntityConnectionDto:
|
|
1042
|
+
type: object
|
|
1043
|
+
properties:
|
|
1044
|
+
createdAt:
|
|
1045
|
+
type: string
|
|
1046
|
+
description: Date/time the connection was created (ISO string)
|
|
1047
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
1048
|
+
updatedAt:
|
|
1049
|
+
type: string
|
|
1050
|
+
description: Date/time the connection was last updated (ISO string)
|
|
1051
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
1052
|
+
state:
|
|
1053
|
+
type: string
|
|
1054
|
+
description: Connection state
|
|
1055
|
+
enum:
|
|
1056
|
+
- requested
|
|
1057
|
+
- active
|
|
1058
|
+
- rejected
|
|
1059
|
+
required:
|
|
1060
|
+
- state
|
|
1061
|
+
UserEntityConnectionDto:
|
|
1062
|
+
type: object
|
|
1063
|
+
properties:
|
|
1064
|
+
createdAt:
|
|
1065
|
+
type: string
|
|
1066
|
+
description: Date/time the connection was created (ISO string)
|
|
1067
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
1068
|
+
updatedAt:
|
|
1069
|
+
type: string
|
|
1070
|
+
description: Date/time the connection was last updated (ISO string)
|
|
1071
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
1072
|
+
state:
|
|
1073
|
+
type: string
|
|
1074
|
+
description: Connection state
|
|
1075
|
+
enum:
|
|
1076
|
+
- requested
|
|
1077
|
+
- active
|
|
1078
|
+
- rejected
|
|
1079
|
+
userId:
|
|
1080
|
+
type: string
|
|
1081
|
+
description: User ID
|
|
1082
|
+
example: user-123
|
|
1083
|
+
required:
|
|
1084
|
+
- state
|
|
1085
|
+
- userId
|
|
1086
|
+
GetUsersDto:
|
|
1087
|
+
type: object
|
|
1088
|
+
properties:
|
|
1089
|
+
userIds:
|
|
1090
|
+
description: The IDs of the users
|
|
1091
|
+
example:
|
|
1092
|
+
- 123e4567-e89b-12d3-a456-426614174000
|
|
1093
|
+
- 123e4567-e89b-12d3-a456-426614174001
|
|
1094
|
+
type: array
|
|
1095
|
+
items:
|
|
1096
|
+
type: string
|
|
1097
|
+
required:
|
|
1098
|
+
- userIds
|
|
1099
|
+
GroupEntityConnectionDto:
|
|
1100
|
+
type: object
|
|
1101
|
+
properties:
|
|
1102
|
+
createdAt:
|
|
1103
|
+
type: string
|
|
1104
|
+
description: Date/time the connection was created (ISO string)
|
|
1105
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
1106
|
+
updatedAt:
|
|
1107
|
+
type: string
|
|
1108
|
+
description: Date/time the connection was last updated (ISO string)
|
|
1109
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
1110
|
+
state:
|
|
1111
|
+
type: string
|
|
1112
|
+
description: Connection state
|
|
1113
|
+
enum:
|
|
1114
|
+
- requested
|
|
1115
|
+
- active
|
|
1116
|
+
- rejected
|
|
1117
|
+
groupId:
|
|
1118
|
+
type: string
|
|
1119
|
+
description: Group ID
|
|
1120
|
+
example: group-123
|
|
1121
|
+
required:
|
|
1122
|
+
- state
|
|
1123
|
+
- groupId
|
|
1124
|
+
EventEntityConnectionDto:
|
|
1125
|
+
type: object
|
|
1126
|
+
properties:
|
|
1127
|
+
createdAt:
|
|
1128
|
+
type: string
|
|
1129
|
+
description: Date/time the connection was created (ISO string)
|
|
1130
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
1131
|
+
updatedAt:
|
|
1132
|
+
type: string
|
|
1133
|
+
description: Date/time the connection was last updated (ISO string)
|
|
1134
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
1135
|
+
state:
|
|
1136
|
+
type: string
|
|
1137
|
+
description: Connection state
|
|
1138
|
+
enum:
|
|
1139
|
+
- requested
|
|
1140
|
+
- active
|
|
1141
|
+
- rejected
|
|
1142
|
+
eventId:
|
|
1143
|
+
type: string
|
|
1144
|
+
description: Event ID
|
|
1145
|
+
example: event-123
|
|
1146
|
+
required:
|
|
1147
|
+
- state
|
|
1148
|
+
- eventId
|
|
1149
|
+
CreateEventDto:
|
|
1150
|
+
type: object
|
|
1151
|
+
properties:
|
|
1152
|
+
displayName:
|
|
1153
|
+
type: string
|
|
1154
|
+
description: Display name
|
|
1155
|
+
example: Display Name
|
|
1156
|
+
requesterUserId:
|
|
1157
|
+
type: string
|
|
1158
|
+
description: User ID of the requester
|
|
1159
|
+
example: user-123
|
|
1160
|
+
visibility:
|
|
1161
|
+
type: string
|
|
1162
|
+
description: Visibility of the entity
|
|
1163
|
+
enum:
|
|
1164
|
+
- public
|
|
1165
|
+
- connections
|
|
1166
|
+
- hidden
|
|
1167
|
+
example: public
|
|
1168
|
+
location:
|
|
1169
|
+
description: Optional location information
|
|
1170
|
+
allOf:
|
|
1171
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1172
|
+
description:
|
|
1173
|
+
type: string
|
|
1174
|
+
description: Entity description
|
|
1175
|
+
example: A description of the entity
|
|
1176
|
+
tags:
|
|
1177
|
+
description: Entity tags
|
|
1178
|
+
example:
|
|
1179
|
+
- tag1
|
|
1180
|
+
- tag2
|
|
1181
|
+
type: array
|
|
1182
|
+
items:
|
|
1183
|
+
type: string
|
|
1184
|
+
eventId:
|
|
1185
|
+
type: string
|
|
1186
|
+
description: Unique event identifier
|
|
1187
|
+
example: event-123
|
|
1188
|
+
startTime:
|
|
1189
|
+
type: string
|
|
1190
|
+
description: Start time (ISO 8601)
|
|
1191
|
+
example: '2024-07-15T18:00:00Z'
|
|
1192
|
+
endTime:
|
|
1193
|
+
type: string
|
|
1194
|
+
description: End time (ISO 8601)
|
|
1195
|
+
example: '2024-07-15T22:00:00Z'
|
|
1196
|
+
type:
|
|
1197
|
+
type: string
|
|
1198
|
+
description: Event type
|
|
1199
|
+
example: concert
|
|
1200
|
+
associatedGroupId:
|
|
1201
|
+
type: string
|
|
1202
|
+
description: Identifier of associated group which owns the event. Owners/admins of the group will be admins of the event.
|
|
1203
|
+
example: group-123
|
|
1204
|
+
required:
|
|
1205
|
+
- displayName
|
|
1206
|
+
- requesterUserId
|
|
1207
|
+
- visibility
|
|
1208
|
+
- eventId
|
|
1209
|
+
- startTime
|
|
1210
|
+
- endTime
|
|
1211
|
+
- type
|
|
1212
|
+
EventDto:
|
|
1213
|
+
type: object
|
|
1214
|
+
properties:
|
|
1215
|
+
entityId:
|
|
1216
|
+
type: string
|
|
1217
|
+
description: Unique identifier for the entity
|
|
1218
|
+
example: entity-123
|
|
1219
|
+
tenantId:
|
|
1220
|
+
type: string
|
|
1221
|
+
description: Tenant identifier the entity belongs to
|
|
1222
|
+
example: tenant-abc
|
|
1223
|
+
displayName:
|
|
1224
|
+
type: string
|
|
1225
|
+
description: Display name of the entity
|
|
1226
|
+
example: Sample Entity
|
|
1227
|
+
visibility:
|
|
1228
|
+
type: string
|
|
1229
|
+
description: Visibility of the entity
|
|
1230
|
+
enum:
|
|
1231
|
+
- PUBLIC
|
|
1232
|
+
- PRIVATE
|
|
1233
|
+
example: PUBLIC
|
|
1234
|
+
description:
|
|
1235
|
+
type: string
|
|
1236
|
+
description: Description of the entity
|
|
1237
|
+
example: A description of the entity
|
|
1238
|
+
tags:
|
|
1239
|
+
description: Tags associated with the entity
|
|
1240
|
+
example:
|
|
1241
|
+
- tag1
|
|
1242
|
+
- tag2
|
|
1243
|
+
type: array
|
|
1244
|
+
items:
|
|
1245
|
+
type: string
|
|
1246
|
+
createdAt:
|
|
1247
|
+
type: string
|
|
1248
|
+
description: Date/time the entity was created (ISO string)
|
|
1249
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
1250
|
+
updatedAt:
|
|
1251
|
+
type: string
|
|
1252
|
+
description: Date/time the entity was last updated (ISO string)
|
|
1253
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
1254
|
+
location:
|
|
1255
|
+
description: Required location information
|
|
1256
|
+
allOf:
|
|
1257
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1258
|
+
startTime:
|
|
1259
|
+
type: string
|
|
1260
|
+
description: Start time (ISO 8601)
|
|
1261
|
+
example: '2024-07-15T18:00:00Z'
|
|
1262
|
+
endTime:
|
|
1263
|
+
type: string
|
|
1264
|
+
description: End time (ISO 8601)
|
|
1265
|
+
example: '2024-07-15T22:00:00Z'
|
|
1266
|
+
type:
|
|
1267
|
+
type: string
|
|
1268
|
+
description: Event type
|
|
1269
|
+
example: concert
|
|
1270
|
+
associatedGroupId:
|
|
1271
|
+
type: string
|
|
1272
|
+
description: Identifier of associated group which owns the event. Owners/admins of the group will be admins of the event.
|
|
1273
|
+
example: group-123
|
|
1274
|
+
required:
|
|
1275
|
+
- startTime
|
|
1276
|
+
- endTime
|
|
1277
|
+
- type
|
|
1278
|
+
UpdateEventDto:
|
|
1279
|
+
type: object
|
|
1280
|
+
properties:
|
|
1281
|
+
requesterUserId:
|
|
1282
|
+
type: string
|
|
1283
|
+
description: User ID of the requester
|
|
1284
|
+
example: user-123
|
|
1285
|
+
visibility:
|
|
1286
|
+
type: string
|
|
1287
|
+
description: Visibility of the entity
|
|
1288
|
+
enum:
|
|
1289
|
+
- public
|
|
1290
|
+
- connections
|
|
1291
|
+
- hidden
|
|
1292
|
+
example: public
|
|
1293
|
+
displayName:
|
|
1294
|
+
type: string
|
|
1295
|
+
description: Display name
|
|
1296
|
+
example: Display Name
|
|
1297
|
+
location:
|
|
1298
|
+
description: Optional location information
|
|
1299
|
+
allOf:
|
|
1300
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1301
|
+
description:
|
|
1302
|
+
type: string
|
|
1303
|
+
description: Entity description
|
|
1304
|
+
example: A description of the entity
|
|
1305
|
+
tags:
|
|
1306
|
+
description: Entity tags
|
|
1307
|
+
example:
|
|
1308
|
+
- tag1
|
|
1309
|
+
- tag2
|
|
1310
|
+
type: array
|
|
1311
|
+
items:
|
|
1312
|
+
type: string
|
|
1313
|
+
startTime:
|
|
1314
|
+
type: string
|
|
1315
|
+
description: Start time (ISO 8601)
|
|
1316
|
+
example: '2024-07-15T18:00:00Z'
|
|
1317
|
+
endTime:
|
|
1318
|
+
type: string
|
|
1319
|
+
description: End time (ISO 8601)
|
|
1320
|
+
example: '2024-07-15T22:00:00Z'
|
|
1321
|
+
type:
|
|
1322
|
+
type: string
|
|
1323
|
+
description: Event type
|
|
1324
|
+
example: concert
|
|
1325
|
+
required:
|
|
1326
|
+
- requesterUserId
|
|
1327
|
+
- displayName
|
|
1328
|
+
- startTime
|
|
1329
|
+
- endTime
|
|
1330
|
+
- type
|
|
1331
|
+
GetEventsDto:
|
|
1332
|
+
type: object
|
|
1333
|
+
properties:
|
|
1334
|
+
eventIds:
|
|
1335
|
+
description: The IDs of the events
|
|
1336
|
+
example:
|
|
1337
|
+
- 123e4567-e89b-12d3-a456-426614174000
|
|
1338
|
+
- 123e4567-e89b-12d3-a456-426614174001
|
|
1339
|
+
type: array
|
|
1340
|
+
items:
|
|
1341
|
+
type: string
|
|
1342
|
+
required:
|
|
1343
|
+
- eventIds
|
|
1344
|
+
CreateGroupDto:
|
|
1345
|
+
type: object
|
|
1346
|
+
properties:
|
|
1347
|
+
displayName:
|
|
1348
|
+
type: string
|
|
1349
|
+
description: Display name
|
|
1350
|
+
example: Display Name
|
|
1351
|
+
requesterUserId:
|
|
1352
|
+
type: string
|
|
1353
|
+
description: User ID of the requester
|
|
1354
|
+
example: user-123
|
|
1355
|
+
visibility:
|
|
1356
|
+
type: string
|
|
1357
|
+
description: Visibility of the entity
|
|
1358
|
+
enum:
|
|
1359
|
+
- public
|
|
1360
|
+
- connections
|
|
1361
|
+
- hidden
|
|
1362
|
+
example: public
|
|
1363
|
+
location:
|
|
1364
|
+
description: Optional location information
|
|
1365
|
+
allOf:
|
|
1366
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1367
|
+
description:
|
|
1368
|
+
type: string
|
|
1369
|
+
description: Entity description
|
|
1370
|
+
example: A description of the entity
|
|
1371
|
+
tags:
|
|
1372
|
+
description: Entity tags
|
|
1373
|
+
example:
|
|
1374
|
+
- tag1
|
|
1375
|
+
- tag2
|
|
1376
|
+
type: array
|
|
1377
|
+
items:
|
|
1378
|
+
type: string
|
|
1379
|
+
groupId:
|
|
1380
|
+
type: string
|
|
1381
|
+
description: Unique group identifier
|
|
1382
|
+
example: group-123
|
|
1383
|
+
type:
|
|
1384
|
+
type: string
|
|
1385
|
+
description: Group type
|
|
1386
|
+
example: club
|
|
1387
|
+
required:
|
|
1388
|
+
- displayName
|
|
1389
|
+
- requesterUserId
|
|
1390
|
+
- visibility
|
|
1391
|
+
- groupId
|
|
1392
|
+
- type
|
|
1393
|
+
GroupDto:
|
|
1394
|
+
type: object
|
|
1395
|
+
properties:
|
|
1396
|
+
entityId:
|
|
1397
|
+
type: string
|
|
1398
|
+
description: Unique identifier for the entity
|
|
1399
|
+
example: entity-123
|
|
1400
|
+
tenantId:
|
|
1401
|
+
type: string
|
|
1402
|
+
description: Tenant identifier the entity belongs to
|
|
1403
|
+
example: tenant-abc
|
|
1404
|
+
displayName:
|
|
1405
|
+
type: string
|
|
1406
|
+
description: Display name of the entity
|
|
1407
|
+
example: Sample Entity
|
|
1408
|
+
visibility:
|
|
1409
|
+
type: string
|
|
1410
|
+
description: Visibility of the entity
|
|
1411
|
+
enum:
|
|
1412
|
+
- PUBLIC
|
|
1413
|
+
- PRIVATE
|
|
1414
|
+
example: PUBLIC
|
|
1415
|
+
description:
|
|
1416
|
+
type: string
|
|
1417
|
+
description: Description of the entity
|
|
1418
|
+
example: A description of the entity
|
|
1419
|
+
tags:
|
|
1420
|
+
description: Tags associated with the entity
|
|
1421
|
+
example:
|
|
1422
|
+
- tag1
|
|
1423
|
+
- tag2
|
|
1424
|
+
type: array
|
|
1425
|
+
items:
|
|
1426
|
+
type: string
|
|
1427
|
+
createdAt:
|
|
1428
|
+
type: string
|
|
1429
|
+
description: Date/time the entity was created (ISO string)
|
|
1430
|
+
example: '2024-05-01T12:34:56.789Z'
|
|
1431
|
+
updatedAt:
|
|
1432
|
+
type: string
|
|
1433
|
+
description: Date/time the entity was last updated (ISO string)
|
|
1434
|
+
example: '2024-05-02T12:34:56.789Z'
|
|
1435
|
+
location:
|
|
1436
|
+
description: Required location information
|
|
1437
|
+
allOf:
|
|
1438
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1439
|
+
type:
|
|
1440
|
+
type: string
|
|
1441
|
+
description: Group type
|
|
1442
|
+
example: club
|
|
1443
|
+
required:
|
|
1444
|
+
- type
|
|
1445
|
+
UpdateGroupDto:
|
|
1446
|
+
type: object
|
|
1447
|
+
properties:
|
|
1448
|
+
requesterUserId:
|
|
1449
|
+
type: string
|
|
1450
|
+
description: User ID of the requester
|
|
1451
|
+
example: user-123
|
|
1452
|
+
visibility:
|
|
1453
|
+
type: string
|
|
1454
|
+
description: Visibility of the entity
|
|
1455
|
+
enum:
|
|
1456
|
+
- public
|
|
1457
|
+
- connections
|
|
1458
|
+
- hidden
|
|
1459
|
+
example: public
|
|
1460
|
+
displayName:
|
|
1461
|
+
type: string
|
|
1462
|
+
description: Display name
|
|
1463
|
+
example: Display Name
|
|
1464
|
+
location:
|
|
1465
|
+
description: Optional location information
|
|
1466
|
+
allOf:
|
|
1467
|
+
- $ref: '#/components/schemas/LocationDto'
|
|
1468
|
+
description:
|
|
1469
|
+
type: string
|
|
1470
|
+
description: Entity description
|
|
1471
|
+
example: A description of the entity
|
|
1472
|
+
tags:
|
|
1473
|
+
description: Entity tags
|
|
1474
|
+
example:
|
|
1475
|
+
- tag1
|
|
1476
|
+
- tag2
|
|
1477
|
+
type: array
|
|
1478
|
+
items:
|
|
1479
|
+
type: string
|
|
1480
|
+
type:
|
|
1481
|
+
type: string
|
|
1482
|
+
description: Group type
|
|
1483
|
+
example: club
|
|
1484
|
+
required:
|
|
1485
|
+
- requesterUserId
|
|
1486
|
+
- displayName
|
|
1487
|
+
- type
|
|
1488
|
+
GetGroupsDto:
|
|
1489
|
+
type: object
|
|
1490
|
+
properties:
|
|
1491
|
+
groupIds:
|
|
1492
|
+
description: The IDs of the groups
|
|
1493
|
+
example:
|
|
1494
|
+
- 123e4567-e89b-12d3-a456-426614174000
|
|
1495
|
+
- 123e4567-e89b-12d3-a456-426614174001
|
|
1496
|
+
type: array
|
|
1497
|
+
items:
|
|
1498
|
+
type: string
|
|
1499
|
+
required:
|
|
1500
|
+
- groupIds
|