-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2361 lines (2250 loc) · 67.2 KB
/
Copy pathopenapi.yaml
File metadata and controls
2361 lines (2250 loc) · 67.2 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
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: "3.1.0"
info:
title: Platform API
description: |
Production-grade SaaS platform API. Modular monolith with RBAC+PBAC authorization,
multi-email/phone support, feature flags, and comprehensive audit logging.
## Authentication
Most endpoints require a valid JWT access token in the `Authorization: Bearer <token>` header.
## Rate Limiting
Rate limits are applied per-endpoint. Response headers indicate limit status:
- `X-RateLimit-Limit` — Maximum requests allowed
- `X-RateLimit-Remaining` — Requests remaining in window
- `X-RateLimit-Reset` — Unix timestamp when window resets
## Error Format
All errors follow RFC 7807 Problem Details:
```json
{
"type": "https://api.platform.dev/errors/validation",
"title": "Validation Error",
"status": 422,
"detail": "Email is required",
"instance": "/auth/register",
"errors": [{"field": "email", "message": "required"}]
}
```
version: "1.0.0"
contact:
name: Platform Support
license:
name: Proprietary
servers:
- url: http://localhost:8080
description: Local development
- url: https://api.staging.platform.dev
description: Staging
- url: https://api.platform.dev
description: Production
tags:
- name: Health
description: Health and readiness checks
- name: Auth
description: Authentication, registration, and account management
- name: Users
description: User profile and current-user management
- name: User Emails
description: Multi-email management per user
- name: User Phones
description: Multi-phone management per user
- name: Workspaces
description: Workspace CRUD, settings, and audit
- name: Workspace Members
description: Workspace membership management
- name: Invitations
description: Workspace invitation lifecycle
- name: Feature Flags
description: System feature flag administration, resolution, and overrides
paths:
# ──────────────────────────────────────────────
# Health
# ──────────────────────────────────────────────
/healthz:
get:
operationId: healthLiveness
tags: [Health]
summary: Liveness probe
description: Returns 200 if the process is alive. Used by Kubernetes livenessProbe.
responses:
"200":
description: Service is alive
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
/readyz:
get:
operationId: healthReadiness
tags: [Health]
summary: Readiness probe
description: |
Returns 200 if the service is ready to accept traffic.
Checks: PostgreSQL connectivity, Redis connectivity, migrations complete, module init.
Used by Kubernetes readinessProbe.
responses:
"200":
description: Service is ready
content:
application/json:
schema:
$ref: "#/components/schemas/ReadyResponse"
"503":
description: Service is not ready
content:
application/json:
schema:
$ref: "#/components/schemas/ReadyResponse"
# ──────────────────────────────────────────────
# Auth
# ──────────────────────────────────────────────
/auth/register:
post:
operationId: authRegister
tags: [Auth]
summary: Register a new user
description: |
Creates a new user account. Sends email verification to the primary email.
The user is not activated until email is verified.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RegisterRequest"
responses:
"201":
description: User created, verification email sent
content:
application/json:
schema:
$ref: "#/components/schemas/UserResponse"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/ValidationError"
/auth/login:
post:
operationId: authLogin
tags: [Auth]
summary: Log in
description: |
Authenticates a user by email+password. Returns access and refresh tokens.
Respects account lockout after failed attempts. Rate limited to 5/min per IP.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LoginRequest"
responses:
"200":
description: Login successful
content:
application/json:
schema:
$ref: "#/components/schemas/TokenResponse"
"401":
$ref: "#/components/responses/Unauthorized"
"423":
description: Account locked
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
/auth/logout:
post:
operationId: authLogout
tags: [Auth]
summary: Log out
description: Revokes the current refresh token and invalidates the session.
security:
- bearerAuth: []
responses:
"204":
description: Logged out successfully
"401":
$ref: "#/components/responses/Unauthorized"
/auth/logout-all:
post:
operationId: authLogoutAll
tags: [Auth]
summary: Log out of all sessions
description: Revokes all refresh tokens for the current user across all devices.
security:
- bearerAuth: []
responses:
"204":
description: All sessions revoked
"401":
$ref: "#/components/responses/Unauthorized"
/auth/refresh:
post:
operationId: authRefresh
tags: [Auth]
summary: Refresh access token
description: |
Exchanges a valid refresh token for a new access+refresh token pair.
The old refresh token is revoked (rotation). Detects reuse and revokes all tokens.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RefreshRequest"
responses:
"200":
description: Tokens refreshed
content:
application/json:
schema:
$ref: "#/components/schemas/TokenResponse"
"401":
description: Invalid or reused refresh token
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
/auth/verify-email:
post:
operationId: authVerifyEmail
tags: [Auth]
summary: Verify email address
description: Verifies a specific email address via verification token.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/EmailVerifyRequest"
responses:
"204":
description: Email verified
"400":
description: Invalid or expired token
/auth/verify-email/resend:
post:
operationId: authResendEmailVerification
tags: [Auth]
summary: Resend email verification
description: Resends the verification email. Rate limited with cooldown.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [email_id]
properties:
email_id:
type: string
format: uuid
responses:
"204":
description: Verification email resent
"400":
description: Email already verified or cooldown active
/auth/verify-phone:
post:
operationId: authVerifyPhone
tags: [Auth]
summary: Verify phone number
description: Verifies a specific phone number via SMS code.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PhoneVerifyRequest"
responses:
"204":
description: Phone verified
"400":
description: Invalid or expired code
/auth/verify-phone/resend:
post:
operationId: authResendPhoneVerification
tags: [Auth]
summary: Resend phone verification
description: Resends the SMS verification code. Rate limited with cooldown.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [phone_id]
properties:
phone_id:
type: string
format: uuid
responses:
"204":
description: Verification code resent
"400":
description: Phone already verified or cooldown active
/auth/forgot-password:
post:
operationId: authForgotPassword
tags: [Auth]
summary: Request password reset
description: |
Sends a password reset email. Always returns 200 to prevent email enumeration.
Rate limited to 3/min per email.
requestBody:
required: true
content:
application/json:
schema:
$ref: #/components/schemas/ForgotPasswordRequest
responses:
"200":
description: If the email exists, a reset link has been sent
/auth/reset-password:
post:
operationId: authResetPassword
tags: [Auth]
summary: Reset password
description: Resets password using a valid reset token.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ResetPasswordRequest"
responses:
"204":
description: Password reset successful
"400":
description: Invalid or expired token
/auth/mfa/enable:
post:
operationId: authMfaEnable
tags: [Auth]
summary: Enable MFA
description: Generates a TOTP secret and returns QR code URL and recovery codes.
security:
- bearerAuth: []
responses:
"200":
description: MFA setup initiated
content:
application/json:
schema:
$ref: "#/components/schemas/MfaEnableResponse"
"409":
description: MFA already enabled
/auth/mfa/verify:
post:
operationId: authMfaVerify
tags: [Auth]
summary: Verify MFA setup
description: Verifies a TOTP code to complete MFA activation.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/MfaVerifyRequest"
responses:
"204":
description: MFA enabled
"401":
description: Invalid TOTP code
/auth/mfa/disable:
post:
operationId: authMfaDisable
tags: [Auth]
summary: Disable MFA
description: Disables MFA. Requires a valid TOTP code for confirmation.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/MfaVerifyRequest"
responses:
"204":
description: MFA disabled
"401":
description: Invalid TOTP code
# ──────────────────────────────────────────────
# Users (current user)
# ──────────────────────────────────────────────
/users/me:
get:
operationId: getMe
tags: [Users]
summary: Get current user profile
description: Returns the authenticated user's profile including emails, phones, and roles.
security:
- bearerAuth: []
responses:
"200":
description: Current user
content:
application/json:
schema:
$ref: "#/components/schemas/CurrentUserResponse"
"401":
$ref: "#/components/responses/Unauthorized"
put:
operationId: updateMe
tags: [Users]
summary: Update current user profile
description: Updates the current user's display name and metadata.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateUserRequest"
responses:
"200":
description: User updated
content:
application/json:
schema:
$ref: "#/components/schemas/UserResponse"
"401":
$ref: "#/components/responses/Unauthorized"
"422":
$ref: "#/components/responses/ValidationError"
delete:
operationId: deleteMe
tags: [Users]
summary: Delete current user
description: Permanently deletes the current user account and all associated data.
security:
- bearerAuth: []
responses:
"204":
description: Account deleted
"401":
$ref: "#/components/responses/Unauthorized"
/users/me/avatar:
put:
operationId: updateMeAvatar
tags: [Users]
summary: Update avatar
description: Uploads a new avatar image for the current user.
security:
- bearerAuth: []
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required: [avatar]
properties:
avatar:
type: string
format: binary
description: Avatar image (JPEG, PNG, max 5MB)
responses:
"200":
description: Avatar updated
content:
application/json:
schema:
type: object
properties:
avatar_url:
type: string
format: uri
"401":
$ref: "#/components/responses/Unauthorized"
"413":
description: File too large
/users/me/password:
put:
operationId: updateMePassword
tags: [Users]
summary: Change password
description: Changes the current user's password. Requires current password.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ChangePasswordRequest"
responses:
"204":
description: Password changed
"401":
$ref: "#/components/responses/Unauthorized"
"422":
$ref: "#/components/responses/ValidationError"
/users/me/preferences:
put:
operationId: updateMePreferences
tags: [Users]
summary: Update preferences
description: Updates the current user's preference settings.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateSettingsRequest"
responses:
"200":
description: Preferences updated
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/Setting"
"401":
$ref: "#/components/responses/Unauthorized"
/users/me/workspaces:
get:
operationId: getMyWorkspaces
tags: [Users]
summary: List my workspaces
description: Returns all workspaces the current user is a member of.
security:
- bearerAuth: []
responses:
"200":
description: List of workspaces
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/Workspace"
"401":
$ref: "#/components/responses/Unauthorized"
# ──────────────────────────────────────────────
# User Emails
# ──────────────────────────────────────────────
/users/me/emails:
get:
operationId: listMyEmails
tags: [User Emails]
summary: List my emails
description: Returns all email addresses for the current user.
security:
- bearerAuth: []
responses:
"200":
description: List of emails
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/UserEmail"
"401":
$ref: "#/components/responses/Unauthorized"
post:
operationId: addMyEmail
tags: [User Emails]
summary: Add email address
description: |
Adds a new email address. Sends verification email.
Maximum 5 emails per user.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddEmailRequest"
responses:
"201":
description: Email added, verification sent
content:
application/json:
schema:
$ref: "#/components/schemas/UserEmail"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/ValidationError"
/users/me/emails/{email_id}:
delete:
operationId: removeMyEmail
tags: [User Emails]
summary: Remove email address
description: |
Removes an email address. Cannot remove the primary email.
Cannot remove the last verified email.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/EmailId"
responses:
"204":
description: Email removed
"400":
description: Cannot remove primary or last verified email
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
/users/me/emails/{email_id}/set-primary:
post:
operationId: setMyPrimaryEmail
tags: [User Emails]
summary: Set primary email
description: Sets an email as the primary contact email.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/EmailId"
responses:
"204":
description: Primary email updated
"400":
description: Email not verified
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
/users/me/emails/{email_id}/verify:
post:
operationId: verifyMyEmail
tags: [User Emails]
summary: Verify email
description: Verifies a specific email via token (for logged-in users).
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/EmailId"
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [token]
properties:
token:
type: string
format: uuid
responses:
"204":
description: Email verified
"400":
description: Invalid or expired token
/users/me/emails/{email_id}/verify/resend:
post:
operationId: resendMyEmailVerification
tags: [User Emails]
summary: Resend email verification
description: Resends the verification email. Rate limited with cooldown.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/EmailId"
responses:
"204":
description: Verification email resent
"400":
description: Email already verified or cooldown active
# ──────────────────────────────────────────────
# User Phones
# ──────────────────────────────────────────────
/users/me/phones:
get:
operationId: listMyPhones
tags: [User Phones]
summary: List my phones
description: Returns all phone numbers for the current user.
security:
- bearerAuth: []
responses:
"200":
description: List of phones
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/UserPhone"
"401":
$ref: "#/components/responses/Unauthorized"
post:
operationId: addMyPhone
tags: [User Phones]
summary: Add phone number
description: |
Adds a new phone number. Sends SMS verification code.
Maximum 3 phones per user.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddPhoneRequest"
responses:
"201":
description: Phone added, verification code sent
content:
application/json:
schema:
$ref: "#/components/schemas/UserPhone"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/ValidationError"
/users/me/phones/{phone_id}:
delete:
operationId: removeMyPhone
tags: [User Phones]
summary: Remove phone number
description: Removes a phone number. Cannot remove primary or last verified phone.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/PhoneId"
responses:
"204":
description: Phone removed
"400":
description: Cannot remove primary or last verified phone
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
/users/me/phones/{phone_id}/set-primary:
post:
operationId: setMyPrimaryPhone
tags: [User Phones]
summary: Set primary phone
description: Sets a phone as the primary contact number.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/PhoneId"
responses:
"204":
description: Primary phone updated
"400":
description: Phone not verified
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
/users/me/phones/{phone_id}/verify:
post:
operationId: verifyMyPhone
tags: [User Phones]
summary: Verify phone
description: Verifies a specific phone via SMS code (for logged-in users).
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/PhoneId"
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [code]
properties:
code:
type: string
minLength: 6
maxLength: 6
responses:
"204":
description: Phone verified
"400":
description: Invalid or expired code
/users/me/phones/{phone_id}/verify/resend:
post:
operationId: resendMyPhoneVerification
tags: [User Phones]
summary: Resend phone verification
description: Resends the SMS verification code. Rate limited with cooldown.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/PhoneId"
responses:
"204":
description: Verification code resent
"400":
description: Phone already verified or cooldown active
# ──────────────────────────────────────────────
# Feature Flags (admin + resolution)
# ──────────────────────────────────────────────
/feature-flags:
get:
operationId: listFeatureFlags
tags: [Feature Flags]
summary: List all feature flags
description: Returns all system feature flags with their defaults. Requires platform_admin.
security:
- bearerAuth: []
responses:
"200":
description: List of feature flags
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/FeatureFlag"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
post:
operationId: createFeatureFlag
tags: [Feature Flags]
summary: Create feature flag
description: Creates a new system feature flag. Requires platform_admin.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateFeatureFlagRequest"
responses:
"201":
description: Flag created
content:
application/json:
schema:
$ref: "#/components/schemas/FeatureFlag"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/ValidationError"
/feature-flags/{flag_id}:
get:
operationId: getFeatureFlag
tags: [Feature Flags]
summary: Get feature flag details
description: Returns a feature flag with all overrides. Requires platform_admin.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/FlagId"
responses:
"200":
description: Feature flag details
content:
application/json:
schema:
$ref: "#/components/schemas/FeatureFlag"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
put:
operationId: updateFeatureFlag
tags: [Feature Flags]
summary: Update feature flag
description: Updates a system feature flag's default value. Requires platform_admin.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/FlagId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateFeatureFlagRequest"
responses:
"200":
description: Flag updated
content:
application/json:
schema:
$ref: "#/components/schemas/FeatureFlag"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"422":
$ref: "#/components/responses/ValidationError"
delete:
operationId: deleteFeatureFlag
tags: [Feature Flags]
summary: Delete feature flag
description: Deletes a system feature flag and all overrides. Requires platform_admin.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/FlagId"
responses:
"204":
description: Flag deleted
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/feature-flags/{flag_id}/toggle:
post:
operationId: toggleFeatureFlag
tags: [Feature Flags]
summary: Toggle feature flag
description: Toggles a boolean feature flag on/off. Requires platform_admin.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/FlagId"
responses:
"200":
description: Flag toggled
content:
application/json:
schema:
$ref: "#/components/schemas/FeatureFlag"
"400":
description: Flag is not boolean type
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/feature-flags/resolve:
get:
operationId: resolveFeatureFlags
tags: [Feature Flags]
summary: Resolve feature flags
description: |
Returns all feature flags resolved for the current user and workspace.