-
-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathopenapi.json
More file actions
885 lines (885 loc) Β· 24.8 KB
/
openapi.json
File metadata and controls
885 lines (885 loc) Β· 24.8 KB
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
{
"openapi": "3.1.0",
"info": {
"title": "Lunalytics API",
"version": "1.0.0"
},
"paths": {
"/api/auth/config/update": {
"post": {
"summary": "Update authentication configuration",
"description": "Endpoint to handle updating authentication configuration",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/config": {
"get": {
"summary": "Retrieve authentication configuration",
"description": "Endpoint for retrieving authentication configuration",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/callback/twitch": {
"get": {
"summary": "Twitch OAuth callback",
"description": "Endpoint to handle Twitch OAuth provider callback",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/callback/slack": {
"get": {
"summary": "Slack OAuth callback",
"description": "Endpoint to handle Slack OAuth provider callback",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/callback/google": {
"get": {
"summary": "Google OAuth callback",
"description": "Endpoint to handle Google OAuth provider callback",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/callback/github": {
"get": {
"summary": "GitHub OAuth callback",
"description": "Endpoint to handle GitHub OAuth provider callback",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/callback/discord": {
"get": {
"summary": "Discord OAuth callback",
"description": "Endpoint to handle Discord OAuth provider callback",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/callback/custom": {
"get": {
"summary": "Custom OAuth callback",
"description": "Endpoint to handle custom OAuth provider callback",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/user/exists": {
"post": {
"summary": "User exists",
"description": "Endpoint to check if the user exists",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/register": {
"post": {
"summary": "Register user",
"description": "Endpoint to handle user registration with given information",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/setup": {
"post": {
"summary": "Setup Lunalytics",
"description": "Endpoint to handle initial Lunalytics setup",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/login": {
"post": {
"summary": "Login with credentials",
"description": "Endpoint to handle user login with credentials",
"tags": [
"Auth"
],
"deprecated": false,
"query": {
"def": {
"type": "object",
"shape": {
"redirect": {
"def": {
"type": "optional",
"innerType": {
"def": {
"type": "string",
"checks": [
{
"def": {
"type": "string",
"format": "url",
"check": "string_format",
"abort": false
},
"type": "string",
"format": "url",
"minLength": null,
"maxLength": null
}
]
},
"type": "string",
"format": "url",
"minLength": null,
"maxLength": null
}
},
"type": "optional"
}
}
},
"type": "object"
},
"header": {
"def": {
"type": "object",
"shape": {
"user-agent": {
"def": {
"type": "optional",
"innerType": {
"def": {
"type": "string"
},
"type": "string",
"format": null,
"minLength": null,
"maxLength": null
}
},
"type": "optional"
}
}
},
"type": "object"
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string",
"minLength": 8
}
},
"required": [
"email",
"password"
]
}
}
}
},
"responses": {}
}
},
"/api/auth/logout": {
"get": {
"summary": "Logout current user",
"description": "Endpoint to handle user logout",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/platform/{provider}": {
"get": {
"summary": "Redirect to OAuth provider",
"description": "Endpoint to handle redirection to the selected OAuth provider",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/auth/setup/exists": {
"get": {
"summary": "Check if setup exists",
"description": "Endpoint to check if Lunalytics has already been setup",
"tags": [
"Auth"
],
"deprecated": false,
"responses": {}
}
},
"/api/user": {
"get": {
"summary": "Get User",
"description": "Fetches the current session user details. Useful for authentication and user profile display.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/exists": {
"post": {
"summary": "User Exists",
"description": "Checks if a user exists based on the provided email. Useful for registration, invitations, and validation.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/workspaces": {
"get": {
"summary": "Get Workspaces",
"description": "Fetches all workspaces associated with the current user. Useful for workspace management and navigation.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/connections": {
"get": {
"summary": "Get Connections",
"description": "Fetches the current userβs connection status and details. Useful for monitoring linked accounts or integrations.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/update/avatar": {
"post": {
"summary": "Update Avatar",
"description": "Allows users to update their profile avatar image. Useful for personalization and user identity.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/access/remove": {
"post": {
"summary": "Remove User",
"description": "Allows admins to remove a user from the application, revoking their access and permissions. Useful for managing team membership and security.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/delete/account": {
"post": {
"summary": "Delete Account",
"description": "Allows users to permanently delete their account and all associated data. Useful for privacy and user autonomy.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/access/decline": {
"post": {
"summary": "Decline Access",
"description": "Allows admins to decline user access requests, preventing them from joining the application. Useful for controlling who can become a member.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/access/approve": {
"post": {
"summary": "Approve Access",
"description": "Allows admins to approve user access requests, granting permissions to join the application. Useful for onboarding and managing team membership.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/update/username": {
"post": {
"summary": "Update Username",
"description": "Allows users to change their username. Useful for personalization and user identity.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/update/password": {
"post": {
"summary": "Update Password",
"description": "Allows users to change their account password. Useful for security and password management.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/update/settings": {
"post": {
"summary": "Update Settings",
"description": "Allows users to update their account preferences and settings. Useful for customizing user experience.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/connection/create": {
"post": {
"summary": "Create Connection",
"description": "Allows users to create a new connection to external services or accounts. Useful for integrations and expanding functionality.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/connection/delete": {
"post": {
"summary": "Delete Connection",
"description": "Allows users to remove a connection to external services or accounts. Useful for managing integrations and privacy.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/permission/update": {
"post": {
"summary": "Update Permissions",
"description": "Allows administrators to modify user permissions, granting or restricting access to features. Useful for managing roles and security.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/user/transfer/ownership": {
"post": {
"summary": "Transfer Ownership",
"description": "Allows administrators to transfer account or workspace ownership to another user. Useful for changing responsibility or leadership.",
"tags": [
"User"
],
"deprecated": false,
"responses": {}
}
},
"/api/tokens/create": {
"post": {
"summary": "Create token",
"description": "Handle creation of a new API token",
"tags": [
"Tokens"
],
"deprecated": false,
"responses": {}
}
},
"/api/tokens/delete": {
"post": {
"summary": "Delete token",
"description": "Handle deletion of an API token",
"tags": [
"Tokens"
],
"deprecated": false,
"responses": {}
}
},
"/api/tokens/update": {
"post": {
"summary": "Update token",
"description": "Handle updating of an API token",
"tags": [
"Tokens"
],
"deprecated": false,
"responses": {}
}
},
"/api/monitor/pause": {
"post": {
"summary": "Pause Monitor",
"description": "Pauses monitoring checks for a workspace. Useful for maintenance windows or troubleshooting.",
"tags": [
"Monitor"
],
"deprecated": false,
"responses": {}
}
},
"/api/monitor/delete": {
"get": {
"summary": "Delete Monitor",
"description": "Deletes a monitor from a workspace. Useful for removing unused or obsolete monitoring checks.",
"tags": [
"Monitor"
],
"deprecated": false,
"responses": {}
}
},
"/api/monitor/edit": {
"post": {
"summary": "Edit Monitor",
"description": "Edits an existing monitor. Useful for updating monitoring parameters or settings.",
"tags": [
"Monitor"
],
"deprecated": false,
"responses": {}
}
},
"/api/monitor/add": {
"post": {
"summary": "Add Monitor",
"description": "Adds a new monitor to a workspace. Useful for tracking uptime, performance, or service health.",
"tags": [
"Monitor"
],
"deprecated": false,
"responses": {}
}
},
"/api/monitor/status": {
"get": {
"summary": "Monitor Status",
"description": "Retrieves the status of a specific monitor. Useful for checking uptime, performance, or alerts.",
"tags": [
"Monitor"
],
"deprecated": false,
"responses": {}
}
},
"/api/monitor/id": {
"get": {
"summary": "Get Monitor By ID",
"description": "Retrieves a monitor by its ID. Useful for viewing details and status of a specific monitoring check.",
"tags": [
"Monitor"
],
"deprecated": false,
"responses": {}
}
},
"/api/invites/all": {
"get": {
"summary": "Get All Invites",
"description": "Retrieves all invites for a workspace. Useful for tracking pending, accepted, or declined invitations.",
"tags": [
"Invites"
],
"deprecated": false,
"responses": {}
}
},
"/api/invites/create": {
"post": {
"summary": "Create Invite",
"description": "Creates a new invite for a workspace. Useful for onboarding new members or collaborators.",
"tags": [
"Invites"
],
"deprecated": false,
"responses": {}
}
},
"/api/invites/pause": {
"post": {
"summary": "Pause Invite",
"description": "Pauses an invite for a workspace. Useful for temporarily disabling access without deleting the invitation.",
"tags": [
"Invites"
],
"deprecated": false,
"responses": {}
}
},
"/api/invites/delete": {
"post": {
"summary": "Delete Invite",
"description": "Deletes an invite from a workspace. Useful for managing access and removing unused invitations.",
"tags": [
"Invites"
],
"deprecated": false,
"responses": {}
}
},
"/api/incident/create": {
"post": {
"summary": "Create Incident",
"description": "Creates a new incident record. Useful for tracking issues, outages, or events in the system.",
"tags": [
"Incident"
],
"deprecated": false,
"responses": {}
}
},
"/api/incident/delete": {
"post": {
"summary": "Delete Incident",
"description": "Deletes an incident by ID. Useful for removing resolved or irrelevant incidents from the system.",
"tags": [
"Incident"
],
"deprecated": false,
"responses": {}
}
},
"/api/incident/update": {
"post": {
"summary": "Update Incident",
"description": "Updates an existing incident record. Useful for modifying status, details, or resolution information.",
"tags": [
"Incident"
],
"deprecated": false,
"responses": {}
}
},
"/api/incident/messages/create": {
"post": {
"summary": "Create Incident Message",
"description": "Creates a new message for an incident. Useful for communication and updates during incident resolution.",
"tags": [
"Incident"
],
"deprecated": false,
"responses": {}
}
},
"/api/incident/messages/delete": {
"post": {
"summary": "Delete Incident Message",
"description": "Deletes a message from an incident. Useful for removing outdated or incorrect communications.",
"tags": [
"Incident"
],
"deprecated": false,
"responses": {}
}
},
"/api/incident/messages/update": {
"post": {
"summary": "Update Incident Message",
"description": "Updates an existing message for an incident. Useful for correcting or clarifying communication during incident resolution.",
"tags": [
"Incident"
],
"deprecated": false,
"responses": {}
}
},
"/api/provider/delete": {
"post": {
"summary": "Delete OAuth provider",
"description": "Endpoint to handle the deletion of an OAuth provider",
"tags": [
"Provider"
],
"deprecated": false,
"responses": {}
}
},
"/api/provider/configure": {
"post": {
"summary": "Configure OAuth providers",
"description": "Endpoint to handle the configuration of OAuth providers",
"tags": [
"Provider"
],
"deprecated": false,
"responses": {}
}
},
"/api/provider": {
"get": {
"summary": "Get providers",
"description": "Endpoint to handle the retrieval of all current providers",
"tags": [
"Provider"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/create": {
"post": {
"summary": "Create Workspace",
"description": "Creates a new workspace. Useful for organizing projects, teams, or environments.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/members/@me": {
"get": {
"summary": "Get Current Member",
"description": "Fetches information about the current workspace member. Useful for user profile and permissions.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/members": {
"get": {
"summary": "Get Workspace Members",
"description": "Retrieves all members of a workspace. Useful for team management and collaboration.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/monitors": {
"get": {
"summary": "Get Workspace Monitors",
"description": "Retrieves all monitors for a workspace. Useful for tracking uptime, performance, or service health.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/notifications": {
"get": {
"summary": "Get Workspace Notifications",
"description": "Retrieves all notifications for a workspace. Useful for alerting teams about important events or updates.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/incidents": {
"get": {
"summary": "Get Workspace Incidents",
"description": "Retrieves all incidents for a workspace. Useful for monitoring issues, outages, or events.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/status-pages": {
"get": {
"summary": "Get Workspace Status Pages",
"description": "Retrieves all status pages for a workspace. Useful for public communication of system health and incidents.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/workspace/api-tokens": {
"get": {
"summary": "Get Workspace API Tokens",
"description": "Retrieves all API tokens for a workspace. Useful for integration, automation, and access control.",
"tags": [
"Workspace"
],
"deprecated": false,
"responses": {}
}
},
"/api/status-pages/id": {
"get": {
"summary": "Get Status Page By ID",
"description": "Retrieves a status page by its ID. Useful for viewing details and history of a specific public page.",
"tags": [
"Status-pages"
],
"deprecated": false,
"responses": {}
}
},
"/api/status-pages/create": {
"post": {
"summary": "Create Status Page",
"description": "Creates a new status page. Useful for public communication of system health, incidents, or maintenance.",
"tags": [
"Status-pages"
],
"deprecated": false,
"responses": {}
}
},
"/api/status-pages/update": {
"post": {
"summary": "Update Status Page",
"description": "Updates an existing status page. Useful for communicating new incidents, maintenance, or system changes.",
"tags": [
"Status-pages"
],
"deprecated": false,
"responses": {}
}
},
"/api/status-pages/delete": {
"post": {
"summary": "Delete Status Page",
"description": "Deletes a status page by ID. Useful for removing outdated or unnecessary public pages.",
"tags": [
"Status-pages"
],
"deprecated": false,
"responses": {}
}
},
"/api/notification/id": {
"get": {
"summary": "Get Notification By ID",
"description": "Retrieves a notification by its ID. Useful for viewing specific alert details.",
"tags": [
"Notification"
],
"deprecated": false,
"responses": {}
}
},
"/api/notification/create": {
"post": {
"summary": "Create Notification",
"description": "Creates a new notification. Useful for alerting users or teams about important events or updates.",
"tags": [
"Notification"
],
"deprecated": false,
"responses": {}
}
},
"/api/notification/edit": {
"post": {
"summary": "Edit Notification",
"description": "Edits an existing notification. Useful for updating alert content or settings.",
"tags": [
"Notification"
],
"deprecated": false,
"responses": {}
}
},
"/api/notification/delete": {
"get": {
"summary": "Delete Notification",
"description": "Deletes a notification. Useful for removing outdated or irrelevant alerts from the system.",
"tags": [
"Notification"
],
"deprecated": false,
"responses": {}
}
},
"/api/notification/toggle": {
"get": {
"summary": "Toggle Notification",
"description": "Enables or disables a notification. Useful for managing alert status and user preferences.",
"tags": [
"Notification"
],
"deprecated": false,
"responses": {}
}
},
"/api/notification/test": {
"post": {
"summary": "Test Notification",
"description": "Tests a notification to ensure it works correctly. Useful for verifying alert delivery and configuration.",
"tags": [
"Notification"
],
"deprecated": false,
"responses": {}
}
},
"/api/providers": {
"get": {
"summary": "Get providers",
"description": "Endpoint to handle the retrieval of all current providers",
"tags": [
"Provider"
],
"deprecated": false,
"responses": {}
}
}
}
}