-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1201 lines (1177 loc) · 59.6 KB
/
openapi.yaml
File metadata and controls
1201 lines (1177 loc) · 59.6 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: Pluralscape API
version: 0.1.0
description: |
REST API for Pluralscape, a cross-platform plurality management application.
All sensitive data is end-to-end encrypted. The server is zero-knowledge —
it cannot read user content.
## Encryption Model
Pluralscape uses **libsodium** with the following algorithms:
- **Symmetric encryption**: XChaCha20-Poly1305
- **Key exchange**: X25519
- **Key derivation**: Argon2id (for password-to-key derivation)
### Encryption Tiers
Data is encrypted at one of three tiers:
| Tier | Name | Key Source | Use Case |
|------|------|-----------|----------|
| **T1** | Master-key encrypted | User's master key (derived from password via Argon2id) | Private data: member profiles, system settings, notes, journals |
| **T2** | Per-bucket encrypted | Symmetric key scoped to a Privacy Bucket | Shared data: content visible to specific friends via key grants |
| **T3** | Plaintext | None | Non-sensitive metadata: IDs, timestamps, structural relationships |
### How `encryptedData` Fields Work
Most resource endpoints accept and return an `encryptedData` field. This is a
**base64-encoded ciphertext blob** produced client-side:
1. The client serializes the resource's sensitive fields (name, description, etc.)
into a JSON payload
2. The client encrypts that JSON with either the master key (T1) or a bucket key (T2)
using XChaCha20-Poly1305, producing `{ciphertext, nonce}`
3. The client base64-encodes the result and sends it as `encryptedData`
4. The server stores the blob **opaquely** — it never decrypts or inspects the contents
5. On read, the client decrypts the blob using the same key
The server enforces size limits on `encryptedData` but cannot validate its internal
structure. All validation of the decrypted content happens client-side.
### Master Key and Recovery
- The user's **master key** is derived from their password using Argon2id
- The master key is stored encrypted on the server (encrypted with itself)
- A **recovery key** (generated at registration) can decrypt the master key if
the password is forgotten — this is the only recovery mechanism
- Changing a password re-wraps the master key; the underlying encryption keys remain stable
### Privacy Buckets and Friend Sharing
- Each Privacy Bucket has its own symmetric key (T2 encryption)
- When a friend is granted access to a bucket, the bucket key is encrypted with the
friend's public key (X25519) and stored as a **key grant**
- Key rotation re-encrypts all items in a bucket with a new key (see Key Rotation endpoints)
### Device Transfer
When adding a new device, the master key is securely transferred using an
ephemeral X25519 key exchange session (5-minute TTL).
## Authentication
Most endpoints require a Bearer token obtained from `/auth/login` or `/auth/register/commit`.
Pass it in the `Authorization` header: `Authorization: Bearer <sessionToken>`.
Session tokens are 32-byte hex-encoded values (64 characters).
## Pagination
List endpoints use cursor-based pagination. Pass `cursor` (opaque string from a
previous response) and `limit` (default 25, max 100) as query parameters.
Responses include `nextCursor` (null when no more pages) and `hasMore`.
## Rate Limiting
All endpoints are subject to per-IP rate limits. When exceeded, the API returns
`429 Too Many Requests` with a `Retry-After` header.
## Error Envelope
All errors follow a consistent JSON structure (see `ErrorResponse` schema).
## Client-Side Plaintext Schemas
Since the server is zero-knowledge, it cannot validate the contents of `encryptedData`
fields. The **Plaintext*** schemas in the components section document what the client
should serialize into JSON, then encrypt, before sending as `encryptedData`. These are
**client-enforced contracts** — the server stores the blob opaquely. See each resource
endpoint's description for which plaintext schema applies.
license:
name: AGPL-3.0
url: https://www.gnu.org/licenses/agpl-3.0.html
contact:
name: Pluralscape
servers:
- url: http://localhost:3000/v1
description: Local development
security:
- bearerAuth: []
x-tagGroups:
- name: Infrastructure
tags: [Health, I18n]
- name: Authentication & Account
tags: [Auth, Account, Friends]
- name: System Management
tags: [Systems, System Settings]
- name: Core Resources
tags: [Members, Member Photos, Member Fields, Groups, Custom Fronts, Fields, Relationships]
- name: System Structures
tags: [Subsystems, Side Systems, Layers, Structure Links, Structure Memberships]
- name: Lifecycle & Innerworld
tags: [Lifecycle Events, Innerworld]
- name: Fronting
tags: [Fronting Sessions, Fronting Comments, Timer Configs, Check-In Records]
- name: Analytics
tags: [Analytics, Fronting Reports]
- name: Privacy
tags: [Privacy Buckets, Bucket Content Tags, Bucket Friend Assignments, Bucket Export]
- name: Media & Crypto
tags: [Blobs, Key Rotation]
- name: Notifications
tags: [Notification Configs, Notifications, Device Tokens]
tags:
- name: Health
description: Service health checks
- name: Auth
description: Authentication, sessions, and account recovery
- name: Account
description: Account management and audit log
- name: Friends
description: Friend network and friend-facing dashboard
- name: Systems
description: Plural system profiles
- name: System Settings
description: System settings, nomenclature, PIN, and setup
- name: Members
description: System members (headmates)
- name: Member Photos
description: Photos attached to members
- name: Member Fields
description: Custom field values on members
- name: Groups
description: Member groups and group memberships
- name: Custom Fronts
description: Abstract cognitive states logged like members
- name: Device Tokens
description: Push notification device token registration and management
- name: Notification Configs
description: Per-event notification preferences (enabled, push enabled)
- name: Notifications
description: Real-time notification delivery via Server-Sent Events
- name: Fields
description: Custom field definitions for a system
- name: Relationships
description: Relationships between members
- name: Structure Entity Types
description: User-defined structure entity types within a system
- name: Structure Entities
description: Structure entities (instances of user-defined entity types)
- name: Structure Entity Links
description: Hierarchical parent-child links between structure entities
- name: Structure Entity Member Links
description: Member assignments to structure entities
- name: Structure Entity Associations
description: Directed cross-references between structure entities
- name: Lifecycle Events
description: System lifecycle events (splits, fusions, etc.)
- name: Innerworld
description: Innerworld regions, entities, and canvas
- name: Privacy Buckets
description: Privacy buckets for scoping T2-encrypted content and friend sharing
- name: Bucket Content Tags
description: Tag entities to privacy buckets for friend visibility
- name: Bucket Friend Assignments
description: Grant and revoke friend access to privacy buckets
- name: Bucket Export
description: Export bucket contents for friend-facing data sync
- name: Blobs
description: Encrypted file upload and download
- name: Key Rotation
description: Privacy bucket key rotation
- name: Fronting Sessions
description: Fronting session tracking (who is fronting and when)
- name: Fronting Comments
description: Comments attached to fronting sessions
- name: Analytics
description: Fronting analytics (duration breakdowns, co-fronting statistics)
- name: Fronting Reports
description: Immutable encrypted report snapshots
- name: Timer Configs
description: Recurring check-in timer configurations
- name: Check-In Records
description: Scheduled check-in instances with respond/dismiss lifecycle
- name: Import
description: Data import jobs and source entity mappings.
- name: I18n
description: Translation manifest and namespace proxy for over-the-air locale updates.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Session token from login or registration
parameters:
SystemId:
name: systemId
in: path
required: true
schema:
type: string
pattern: ^sys_
description: System ID (prefixed with `sys_`)
MemberId:
name: memberId
in: path
required: true
schema:
type: string
pattern: ^mem_
description: Member ID (prefixed with `mem_`)
GroupId:
name: groupId
in: path
required: true
schema:
type: string
pattern: ^grp_
description: Group ID (prefixed with `grp_`)
Cursor:
name: cursor
in: query
required: false
schema:
type: string
description: Opaque pagination cursor from a previous response
Limit:
name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 25
description: Maximum number of items to return (default 25, max 100)
schemas:
# Common
ErrorResponse:
$ref: "./schemas/common.yaml#/ErrorResponse"
PaginationMeta:
$ref: "./schemas/common.yaml#/PaginationMeta"
EncryptedEntity:
$ref: "./schemas/common.yaml#/EncryptedEntity"
# Auth
LoginRequest:
$ref: "./schemas/auth.yaml#/LoginRequest"
LoginResponse:
$ref: "./schemas/auth.yaml#/LoginResponse"
SaltRequest:
$ref: "./schemas/auth.yaml#/SaltRequest"
SaltResponse:
$ref: "./schemas/auth.yaml#/SaltResponse"
RegistrationInitiateRequest:
$ref: "./schemas/auth.yaml#/RegistrationInitiateRequest"
RegistrationInitiateResponse:
$ref: "./schemas/auth.yaml#/RegistrationInitiateResponse"
RegistrationCommitRequest:
$ref: "./schemas/auth.yaml#/RegistrationCommitRequest"
RegistrationCommitResponse:
$ref: "./schemas/auth.yaml#/RegistrationCommitResponse"
RegenerateRecoveryKeyResponse:
$ref: "./schemas/auth.yaml#/RegenerateRecoveryKeyResponse"
PasswordResetViaRecoveryKeyRequest:
$ref: "./schemas/auth.yaml#/PasswordResetViaRecoveryKeyRequest"
PasswordResetResponse:
$ref: "./schemas/auth.yaml#/PasswordResetResponse"
BiometricTokenRequest:
$ref: "./schemas/auth.yaml#/BiometricTokenRequest"
BiometricEnrollResponse:
$ref: "./schemas/auth.yaml#/BiometricEnrollResponse"
BiometricVerifyResponse:
$ref: "./schemas/auth.yaml#/BiometricVerifyResponse"
SessionInfo:
$ref: "./schemas/auth.yaml#/SessionInfo"
SessionListResponse:
$ref: "./schemas/auth.yaml#/SessionListResponse"
RegenerateRecoveryKeyRequest:
$ref: "./schemas/auth.yaml#/RegenerateRecoveryKeyRequest"
RecoveryKeyStatusResponse:
$ref: "./schemas/auth.yaml#/RecoveryKeyStatusResponse"
RevokeAllResponse:
$ref: "./schemas/auth.yaml#/RevokeAllResponse"
# Account
AccountInfo:
$ref: "./schemas/account.yaml#/AccountInfo"
ChangeEmailRequest:
$ref: "./schemas/account.yaml#/ChangeEmailRequest"
ChangePasswordRequest:
$ref: "./schemas/account.yaml#/ChangePasswordRequest"
AuditLogQuery:
$ref: "./schemas/account.yaml#/AuditLogQuery"
AuditLogEntry:
$ref: "./schemas/account.yaml#/AuditLogEntry"
AuditLogResponse:
$ref: "./schemas/account.yaml#/AuditLogResponse"
UpdateAccountSettingsRequest:
$ref: "./schemas/account.yaml#/UpdateAccountSettingsRequest"
UpdateAccountSettingsResponse:
$ref: "./schemas/account.yaml#/UpdateAccountSettingsResponse"
DeleteAccountRequest:
$ref: "./schemas/account.yaml#/DeleteAccountRequest"
VerifyPinResponse:
$ref: "./schemas/account.yaml#/VerifyPinResponse"
ActionResponse:
$ref: "./schemas/account.yaml#/ActionResponse"
InitiateTransferRequest:
$ref: "./schemas/account.yaml#/InitiateTransferRequest"
InitiateTransferResponse:
$ref: "./schemas/account.yaml#/InitiateTransferResponse"
CompleteTransferRequest:
$ref: "./schemas/account.yaml#/CompleteTransferRequest"
CompleteTransferResponse:
$ref: "./schemas/account.yaml#/CompleteTransferResponse"
# Systems
SystemProfile:
$ref: "./schemas/systems.yaml#/SystemProfile"
UpdateSystemRequest:
$ref: "./schemas/systems.yaml#/UpdateSystemRequest"
CreateSnapshotRequest:
$ref: "./schemas/systems.yaml#/CreateSnapshotRequest"
SnapshotResponse:
$ref: "./schemas/systems.yaml#/SnapshotResponse"
DuplicateSystemRequest:
$ref: "./schemas/systems.yaml#/DuplicateSystemRequest"
DuplicateSystemResponse:
$ref: "./schemas/systems.yaml#/DuplicateSystemResponse"
PurgeSystemRequest:
$ref: "./schemas/systems.yaml#/PurgeSystemRequest"
# Members
MemberResponse:
$ref: "./schemas/members.yaml#/MemberResponse"
CreateMemberRequest:
$ref: "./schemas/members.yaml#/CreateMemberRequest"
UpdateMemberRequest:
$ref: "./schemas/members.yaml#/UpdateMemberRequest"
DuplicateMemberRequest:
$ref: "./schemas/members.yaml#/DuplicateMemberRequest"
# Member Photos
CreateMemberPhotoRequest:
$ref: "./schemas/member-photos.yaml#/CreateMemberPhotoRequest"
ReorderPhotosRequest:
$ref: "./schemas/member-photos.yaml#/ReorderPhotosRequest"
# Fields
FieldType:
$ref: "./schemas/fields.yaml#/FieldType"
CreateFieldDefinitionRequest:
$ref: "./schemas/fields.yaml#/CreateFieldDefinitionRequest"
UpdateFieldDefinitionRequest:
$ref: "./schemas/fields.yaml#/UpdateFieldDefinitionRequest"
FieldDefinitionResponse:
$ref: "./schemas/fields.yaml#/FieldDefinitionResponse"
SetFieldValueRequest:
$ref: "./schemas/fields.yaml#/SetFieldValueRequest"
UpdateFieldValueRequest:
$ref: "./schemas/fields.yaml#/UpdateFieldValueRequest"
FieldValueResponse:
$ref: "./schemas/fields.yaml#/FieldValueResponse"
# Groups
GroupTreeNode:
$ref: "./schemas/groups.yaml#/GroupTreeNode"
GroupResponse:
$ref: "./schemas/groups.yaml#/GroupResponse"
CreateGroupRequest:
$ref: "./schemas/groups.yaml#/CreateGroupRequest"
UpdateGroupRequest:
$ref: "./schemas/groups.yaml#/UpdateGroupRequest"
MoveGroupRequest:
$ref: "./schemas/groups.yaml#/MoveGroupRequest"
CopyGroupRequest:
$ref: "./schemas/groups.yaml#/CopyGroupRequest"
ReorderGroupsRequest:
$ref: "./schemas/groups.yaml#/ReorderGroupsRequest"
AddGroupMemberRequest:
$ref: "./schemas/groups.yaml#/AddGroupMemberRequest"
GroupMembership:
$ref: "./schemas/groups.yaml#/GroupMembership"
# Custom Fronts
CustomFrontResponse:
$ref: "./schemas/custom-fronts.yaml#/CustomFrontResponse"
CreateCustomFrontRequest:
$ref: "./schemas/custom-fronts.yaml#/CreateCustomFrontRequest"
UpdateCustomFrontRequest:
$ref: "./schemas/custom-fronts.yaml#/UpdateCustomFrontRequest"
# Device Tokens
DeviceTokenPlatform:
$ref: "./schemas/device-tokens.yaml#/DeviceTokenPlatform"
DeviceTokenResponse:
$ref: "./schemas/device-tokens.yaml#/DeviceTokenResponse"
RegisterDeviceTokenRequest:
$ref: "./schemas/device-tokens.yaml#/RegisterDeviceTokenRequest"
DeviceTokenListResponse:
$ref: "./schemas/device-tokens.yaml#/DeviceTokenListResponse"
UpdateDeviceTokenRequest:
$ref: "./schemas/device-tokens.yaml#/UpdateDeviceTokenRequest"
# Notification Configs
NotificationEventType:
$ref: "./schemas/notification-configs.yaml#/NotificationEventType"
NotificationConfigResponse:
$ref: "./schemas/notification-configs.yaml#/NotificationConfigResponse"
UpdateNotificationConfigRequest:
$ref: "./schemas/notification-configs.yaml#/UpdateNotificationConfigRequest"
NotificationConfigListResponse:
$ref: "./schemas/notification-configs.yaml#/NotificationConfigListResponse"
SseStreamEvent:
$ref: "./schemas/notification-configs.yaml#/SseStreamEvent"
# Relationships
RelationshipType:
$ref: "./schemas/relationships.yaml#/RelationshipType"
CreateRelationshipRequest:
$ref: "./schemas/relationships.yaml#/CreateRelationshipRequest"
UpdateRelationshipRequest:
$ref: "./schemas/relationships.yaml#/UpdateRelationshipRequest"
RelationshipResponse:
$ref: "./schemas/relationships.yaml#/RelationshipResponse"
# Structure Entity Types & Entities
CreateStructureEntityTypeRequest:
$ref: "./schemas/structures.yaml#/CreateStructureEntityTypeRequest"
UpdateStructureEntityTypeRequest:
$ref: "./schemas/structures.yaml#/UpdateStructureEntityTypeRequest"
StructureEntityTypeResponse:
$ref: "./schemas/structures.yaml#/StructureEntityTypeResponse"
CreateStructureEntityRequest:
$ref: "./schemas/structures.yaml#/CreateStructureEntityRequest"
UpdateStructureEntityRequest:
$ref: "./schemas/structures.yaml#/UpdateStructureEntityRequest"
StructureEntityResponse:
$ref: "./schemas/structures.yaml#/StructureEntityResponse"
CreateStructureEntityLinkRequest:
$ref: "./schemas/structures.yaml#/CreateStructureEntityLinkRequest"
StructureEntityLinkResponse:
$ref: "./schemas/structures.yaml#/StructureEntityLinkResponse"
CreateStructureEntityMemberLinkRequest:
$ref: "./schemas/structures.yaml#/CreateStructureEntityMemberLinkRequest"
StructureEntityMemberLinkResponse:
$ref: "./schemas/structures.yaml#/StructureEntityMemberLinkResponse"
CreateStructureEntityAssociationRequest:
$ref: "./schemas/structures.yaml#/CreateStructureEntityAssociationRequest"
StructureEntityAssociationResponse:
$ref: "./schemas/structures.yaml#/StructureEntityAssociationResponse"
HierarchyNode:
$ref: "./schemas/structures.yaml#/HierarchyNode"
# Timer Configs & Check-In Records
TimerConfigResponse:
$ref: "./schemas/timers.yaml#/TimerConfigResponse"
CreateTimerConfigRequest:
$ref: "./schemas/timers.yaml#/CreateTimerConfigRequest"
UpdateTimerConfigRequest:
$ref: "./schemas/timers.yaml#/UpdateTimerConfigRequest"
CheckInRecordResponse:
$ref: "./schemas/timers.yaml#/CheckInRecordResponse"
CreateCheckInRecordRequest:
$ref: "./schemas/timers.yaml#/CreateCheckInRecordRequest"
RespondCheckInRecordRequest:
$ref: "./schemas/timers.yaml#/RespondCheckInRecordRequest"
# Lifecycle Events
LifecycleEventType:
$ref: "./schemas/lifecycle-events.yaml#/LifecycleEventType"
CreateLifecycleEventRequest:
$ref: "./schemas/lifecycle-events.yaml#/CreateLifecycleEventRequest"
UpdateLifecycleEventRequest:
$ref: "./schemas/lifecycle-events.yaml#/UpdateLifecycleEventRequest"
LifecycleEventResponse:
$ref: "./schemas/lifecycle-events.yaml#/LifecycleEventResponse"
# Innerworld
CreateRegionRequest:
$ref: "./schemas/innerworld.yaml#/CreateRegionRequest"
UpdateRegionRequest:
$ref: "./schemas/innerworld.yaml#/UpdateRegionRequest"
RegionResponse:
$ref: "./schemas/innerworld.yaml#/RegionResponse"
CreateEntityRequest:
$ref: "./schemas/innerworld.yaml#/CreateEntityRequest"
UpdateEntityRequest:
$ref: "./schemas/innerworld.yaml#/UpdateEntityRequest"
EntityResponse:
$ref: "./schemas/innerworld.yaml#/EntityResponse"
UpdateCanvasRequest:
$ref: "./schemas/innerworld.yaml#/UpdateCanvasRequest"
CanvasResponse:
$ref: "./schemas/innerworld.yaml#/CanvasResponse"
# Privacy Buckets
BucketResponse:
$ref: "./schemas/buckets.yaml#/BucketResponse"
CreateBucketRequest:
$ref: "./schemas/buckets.yaml#/CreateBucketRequest"
UpdateBucketRequest:
$ref: "./schemas/buckets.yaml#/UpdateBucketRequest"
BucketContentTagResponse:
$ref: "./schemas/buckets.yaml#/BucketContentTagResponse"
TagContentRequest:
$ref: "./schemas/buckets.yaml#/TagContentRequest"
AssignBucketFriendRequest:
$ref: "./schemas/buckets.yaml#/AssignBucketFriendRequest"
BucketFriendAssignmentResponse:
$ref: "./schemas/buckets.yaml#/BucketFriendAssignmentResponse"
UnassignBucketFriendResponse:
$ref: "./schemas/buckets.yaml#/UnassignBucketFriendResponse"
# Blobs
BlobPurpose:
$ref: "./schemas/blobs.yaml#/BlobPurpose"
CreateUploadUrlRequest:
$ref: "./schemas/blobs.yaml#/CreateUploadUrlRequest"
UploadUrlResponse:
$ref: "./schemas/blobs.yaml#/UploadUrlResponse"
ConfirmUploadRequest:
$ref: "./schemas/blobs.yaml#/ConfirmUploadRequest"
BlobResponse:
$ref: "./schemas/blobs.yaml#/BlobResponse"
DownloadUrlResponse:
$ref: "./schemas/blobs.yaml#/DownloadUrlResponse"
# Key Rotation
RotationState:
$ref: "./schemas/key-rotation.yaml#/RotationState"
InitiateRotationRequest:
$ref: "./schemas/key-rotation.yaml#/InitiateRotationRequest"
RotationResponse:
$ref: "./schemas/key-rotation.yaml#/RotationResponse"
ClaimChunkRequest:
$ref: "./schemas/key-rotation.yaml#/ClaimChunkRequest"
ClaimChunkResponse:
$ref: "./schemas/key-rotation.yaml#/ClaimChunkResponse"
CompleteChunkRequest:
$ref: "./schemas/key-rotation.yaml#/CompleteChunkRequest"
CompleteChunkResponse:
$ref: "./schemas/key-rotation.yaml#/CompleteChunkResponse"
# Fronting Sessions & Comments
FrontingSessionResponse:
$ref: "./schemas/fronting.yaml#/FrontingSessionResponse"
CreateFrontingSessionRequest:
$ref: "./schemas/fronting.yaml#/CreateFrontingSessionRequest"
UpdateFrontingSessionRequest:
$ref: "./schemas/fronting.yaml#/UpdateFrontingSessionRequest"
EndFrontingSessionRequest:
$ref: "./schemas/fronting.yaml#/EndFrontingSessionRequest"
ActiveFrontingResponse:
$ref: "./schemas/fronting.yaml#/ActiveFrontingResponse"
FrontingCommentResponse:
$ref: "./schemas/fronting.yaml#/FrontingCommentResponse"
CreateFrontingCommentRequest:
$ref: "./schemas/fronting.yaml#/CreateFrontingCommentRequest"
UpdateFrontingCommentRequest:
$ref: "./schemas/fronting.yaml#/UpdateFrontingCommentRequest"
# Analytics & Reports
SubjectFrontingBreakdown:
$ref: "./schemas/analytics.yaml#/SubjectFrontingBreakdown"
FrontingBreakdownResponse:
$ref: "./schemas/analytics.yaml#/FrontingBreakdownResponse"
CoFrontingPair:
$ref: "./schemas/analytics.yaml#/CoFrontingPair"
CoFrontingBreakdownResponse:
$ref: "./schemas/analytics.yaml#/CoFrontingBreakdownResponse"
FrontingReportResponse:
$ref: "./schemas/analytics.yaml#/FrontingReportResponse"
CreateFrontingReportRequest:
$ref: "./schemas/analytics.yaml#/CreateFrontingReportRequest"
# Settings
UpdateSystemSettingsRequest:
$ref: "./schemas/settings.yaml#/UpdateSystemSettingsRequest"
UpdateNomenclatureRequest:
$ref: "./schemas/settings.yaml#/UpdateNomenclatureRequest"
PinRequest:
$ref: "./schemas/settings.yaml#/PinRequest"
PinVerifyResponse:
$ref: "./schemas/settings.yaml#/PinVerifyResponse"
SetupStatusResponse:
$ref: "./schemas/settings.yaml#/SetupStatusResponse"
SetupStepRequest:
$ref: "./schemas/settings.yaml#/SetupStepRequest"
SetupCompleteRequest:
$ref: "./schemas/settings.yaml#/SetupCompleteRequest"
# Friend Dashboard
FriendDashboardResponse:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardResponse"
FriendDashboardFrontingSession:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardFrontingSession"
FriendDashboardMember:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardMember"
FriendDashboardCustomFront:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardCustomFront"
FriendDashboardStructureEntity:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardStructureEntity"
FriendDashboardKeyGrant:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardKeyGrant"
FriendDashboardSyncEntry:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardSyncEntry"
FriendDashboardSyncResponse:
$ref: "./schemas/friend-dashboard.yaml#/FriendDashboardSyncResponse"
# Friends
FriendConnectionResponse:
$ref: "./schemas/friends.yaml#/FriendConnectionResponse"
FriendConnectionWithRotations:
$ref: "./schemas/friends.yaml#/FriendConnectionWithRotations"
FriendConnectionStatus:
$ref: "./schemas/friends.yaml#/FriendConnectionStatus"
FriendConnectionListResponse:
$ref: "./schemas/friends.yaml#/FriendConnectionListResponse"
UpdateFriendVisibilityRequest:
$ref: "./schemas/friends.yaml#/UpdateFriendVisibilityRequest"
FriendCodeResponse:
$ref: "./schemas/friends.yaml#/FriendCodeResponse"
FriendCodeListResponse:
$ref: "./schemas/friends.yaml#/FriendCodeListResponse"
RedeemFriendCodeRequest:
$ref: "./schemas/friends.yaml#/RedeemFriendCodeRequest"
RedeemFriendCodeResponse:
$ref: "./schemas/friends.yaml#/RedeemFriendCodeResponse"
FriendNotificationPreferenceResponse:
$ref: "./schemas/friends.yaml#/FriendNotificationPreferenceResponse"
FriendNotificationEventType:
$ref: "./schemas/friends.yaml#/FriendNotificationEventType"
UpdateFriendNotificationPreferenceRequest:
$ref: "./schemas/friends.yaml#/UpdateFriendNotificationPreferenceRequest"
ReceivedKeyGrant:
$ref: "./schemas/friends.yaml#/ReceivedKeyGrant"
FriendExportEntityType:
$ref: "./schemas/friends.yaml#/FriendExportEntityType"
FriendExportManifestResponse:
$ref: "./schemas/friends.yaml#/FriendExportManifestResponse"
FriendExportManifestEntry:
$ref: "./schemas/friends.yaml#/FriendExportManifestEntry"
FriendExportEntity:
$ref: "./schemas/friends.yaml#/FriendExportEntity"
FriendExportPageResponse:
$ref: "./schemas/friends.yaml#/FriendExportPageResponse"
# Plaintext (client-side encryption contracts)
PlaintextImageSource:
$ref: "./schemas/plaintext.yaml#/PlaintextImageSource"
PlaintextSaturationLevel:
$ref: "./schemas/plaintext.yaml#/PlaintextSaturationLevel"
PlaintextTag:
$ref: "./schemas/plaintext.yaml#/PlaintextTag"
PlaintextVisualProperties:
$ref: "./schemas/plaintext.yaml#/PlaintextVisualProperties"
PlaintextSystem:
$ref: "./schemas/plaintext.yaml#/PlaintextSystem"
PlaintextMember:
$ref: "./schemas/plaintext.yaml#/PlaintextMember"
PlaintextMemberPhoto:
$ref: "./schemas/plaintext.yaml#/PlaintextMemberPhoto"
PlaintextGroup:
$ref: "./schemas/plaintext.yaml#/PlaintextGroup"
PlaintextCustomFront:
$ref: "./schemas/plaintext.yaml#/PlaintextCustomFront"
PlaintextFieldDefinition:
$ref: "./schemas/plaintext.yaml#/PlaintextFieldDefinition"
PlaintextFieldValue:
$ref: "./schemas/plaintext.yaml#/PlaintextFieldValue"
PlaintextRelationship:
$ref: "./schemas/plaintext.yaml#/PlaintextRelationship"
PlaintextStructureEntityType:
$ref: "./schemas/plaintext.yaml#/PlaintextStructureEntityType"
PlaintextStructureEntity:
$ref: "./schemas/plaintext.yaml#/PlaintextStructureEntity"
PlaintextFrontingSession:
$ref: "./schemas/plaintext.yaml#/PlaintextFrontingSession"
PlaintextLifecycleEvent:
$ref: "./schemas/plaintext.yaml#/PlaintextLifecycleEvent"
PlaintextInnerworldRegion:
$ref: "./schemas/plaintext.yaml#/PlaintextInnerworldRegion"
PlaintextInnerworldEntity:
$ref: "./schemas/plaintext.yaml#/PlaintextInnerworldEntity"
PlaintextInnerworldCanvas:
$ref: "./schemas/plaintext.yaml#/PlaintextInnerworldCanvas"
PlaintextSystemSettings:
$ref: "./schemas/plaintext.yaml#/PlaintextSystemSettings"
PlaintextNomenclature:
$ref: "./schemas/plaintext.yaml#/PlaintextNomenclature"
PlaintextStructureEntityMemberLink:
$ref: "./schemas/plaintext.yaml#/PlaintextStructureEntityMemberLink"
PlaintextStructureEntityAssociation:
$ref: "./schemas/plaintext.yaml#/PlaintextStructureEntityAssociation"
responses:
NoContent:
description: Success with no response body
Unauthenticated:
description: Missing or invalid session token
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
ValidationError:
description: Request validation failed
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
Conflict:
description: Resource conflict (duplicate, version mismatch, or has dependents)
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
RateLimited:
description: Rate limit exceeded
headers:
Retry-After:
schema:
type: integer
description: Seconds until the rate limit resets
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
paths:
# Auth
/auth/register/initiate:
$ref: "./paths/auth.yaml#/~1auth~1register~1initiate"
/auth/register/commit:
$ref: "./paths/auth.yaml#/~1auth~1register~1commit"
/auth/salt:
$ref: "./paths/auth.yaml#/~1auth~1salt"
/auth/login:
$ref: "./paths/auth.yaml#/~1auth~1login"
/auth/password-reset/recovery-key:
$ref: "./paths/auth.yaml#/~1auth~1password-reset~1recovery-key"
/auth/biometric/enroll:
$ref: "./paths/auth.yaml#/~1auth~1biometric~1enroll"
/auth/biometric/verify:
$ref: "./paths/auth.yaml#/~1auth~1biometric~1verify"
/auth/sessions:
$ref: "./paths/auth.yaml#/~1auth~1sessions"
/auth/sessions/{id}:
$ref: "./paths/auth.yaml#/~1auth~1sessions~1%7Bid%7D"
/auth/logout:
$ref: "./paths/auth.yaml#/~1auth~1logout"
/auth/sessions/revoke-all:
$ref: "./paths/auth.yaml#/~1auth~1sessions~1revoke-all"
/auth/recovery-key/status:
$ref: "./paths/auth.yaml#/~1auth~1recovery-key~1status"
/auth/recovery-key/regenerate:
$ref: "./paths/auth.yaml#/~1auth~1recovery-key~1regenerate"
# Account
/account:
$ref: "./paths/account.yaml#/~1account"
/account/email:
$ref: "./paths/account.yaml#/~1account~1email"
/account/password:
$ref: "./paths/account.yaml#/~1account~1password"
/account/audit-log:
$ref: "./paths/account.yaml#/~1account~1audit-log"
/account/settings:
$ref: "./paths/account.yaml#/~1account~1settings"
/account/pin:
$ref: "./paths/account.yaml#/~1account~1pin"
/account/pin/verify:
$ref: "./paths/account.yaml#/~1account~1pin~1verify"
/account/device-transfer:
$ref: "./paths/account.yaml#/~1account~1device-transfer"
/account/device-transfer/{transferId}/approve:
$ref: "./paths/account.yaml#/~1account~1device-transfer~1%7BtransferId%7D~1approve"
/account/device-transfer/{transferId}/complete:
$ref: "./paths/account.yaml#/~1account~1device-transfer~1%7BtransferId%7D~1complete"
# Friends
/account/friends:
$ref: "./paths/friends.yaml#/~1account~1friends"
/account/friends/key-grants:
$ref: "./paths/friends.yaml#/~1account~1friends~1key-grants"
/account/friends/{connectionId}:
$ref: "./paths/friends.yaml#/~1account~1friends~1%7BconnectionId%7D"
/account/friends/{connectionId}/block:
$ref: "./paths/friends.yaml#/~1account~1friends~1%7BconnectionId%7D~1block"
/account/friends/{connectionId}/remove:
$ref: "./paths/friends.yaml#/~1account~1friends~1%7BconnectionId%7D~1remove"
/account/friends/{connectionId}/archive:
$ref: "./paths/friends.yaml#/~1account~1friends~1%7BconnectionId%7D~1archive"
/account/friends/{connectionId}/restore:
$ref: "./paths/friends.yaml#/~1account~1friends~1%7BconnectionId%7D~1restore"
/account/friends/{connectionId}/visibility:
$ref: "./paths/friends.yaml#/~1account~1friends~1%7BconnectionId%7D~1visibility"
/account/friends/{connectionId}/notifications:
$ref: "./paths/friend-notifications.yaml#/~1account~1friends~1%7BconnectionId%7D~1notifications"
/account/friends/{connectionId}/export/manifest:
$ref: "./paths/friend-export.yaml#/~1account~1friends~1%7BconnectionId%7D~1export~1manifest"
/account/friends/{connectionId}/export:
$ref: "./paths/friend-export.yaml#/~1account~1friends~1%7BconnectionId%7D~1export"
/account/friends/{connectionId}/dashboard:
$ref: "./paths/friend-dashboard.yaml#/~1account~1friends~1%7BconnectionId%7D~1dashboard"
/account/friends/{connectionId}/dashboard/sync:
$ref: "./paths/friend-dashboard.yaml#/~1account~1friends~1%7BconnectionId%7D~1dashboard~1sync"
# Friend Codes
/account/friend-codes:
$ref: "./paths/friend-codes.yaml#/~1account~1friend-codes"
/account/friend-codes/redeem:
$ref: "./paths/friend-codes.yaml#/~1account~1friend-codes~1redeem"
/account/friend-codes/{codeId}/archive:
$ref: "./paths/friend-codes.yaml#/~1account~1friend-codes~1%7BcodeId%7D~1archive"
# Systems
/systems:
$ref: "./paths/systems.yaml#/~1systems"
/systems/{systemId}:
$ref: "./paths/systems.yaml#/~1systems~1%7BsystemId%7D"
/systems/{systemId}/duplicate:
$ref: "./paths/systems.yaml#/~1systems~1%7BsystemId%7D~1duplicate"
/systems/{systemId}/purge:
$ref: "./paths/systems.yaml#/~1systems~1%7BsystemId%7D~1purge"
/systems/{systemId}/snapshots:
$ref: "./paths/systems.yaml#/~1systems~1%7BsystemId%7D~1snapshots"
/systems/{systemId}/snapshots/{snapshotId}:
$ref: "./paths/systems.yaml#/~1systems~1%7BsystemId%7D~1snapshots~1%7BsnapshotId%7D"
# Settings
/systems/{systemId}/settings:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1settings"
/systems/{systemId}/settings/pin:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1settings~1pin"
/systems/{systemId}/settings/pin/verify:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1settings~1pin~1verify"
/systems/{systemId}/nomenclature:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1nomenclature"
/systems/{systemId}/setup/status:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1setup~1status"
/systems/{systemId}/setup/nomenclature:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1setup~1nomenclature"
/systems/{systemId}/setup/profile:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1setup~1profile"
/systems/{systemId}/setup/complete:
$ref: "./paths/settings.yaml#/~1systems~1%7BsystemId%7D~1setup~1complete"
# Members
/systems/{systemId}/members:
$ref: "./paths/members.yaml#/~1systems~1%7BsystemId%7D~1members"
/systems/{systemId}/members/{memberId}:
$ref: "./paths/members.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D"
/systems/{systemId}/members/{memberId}/duplicate:
$ref: "./paths/members.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1duplicate"
/systems/{systemId}/members/{memberId}/archive:
$ref: "./paths/members.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1archive"
/systems/{systemId}/members/{memberId}/restore:
$ref: "./paths/members.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1restore"
/systems/{systemId}/members/{memberId}/memberships:
$ref: "./paths/members.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1memberships"
# Member Photos
/systems/{systemId}/members/{memberId}/photos:
$ref: "./paths/member-photos.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1photos"
/systems/{systemId}/members/{memberId}/photos/reorder:
$ref: "./paths/member-photos.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1photos~1reorder"
/systems/{systemId}/members/{memberId}/photos/{photoId}/archive:
$ref: "./paths/member-photos.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1photos~1%7BphotoId%7D~1archive"
/systems/{systemId}/members/{memberId}/photos/{photoId}/restore:
$ref: "./paths/member-photos.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1photos~1%7BphotoId%7D~1restore"
/systems/{systemId}/members/{memberId}/photos/{photoId}:
$ref: "./paths/member-photos.yaml#/~1systems~1%7BsystemId%7D~1members~1%7BmemberId%7D~1photos~1%7BphotoId%7D"
# Groups
/systems/{systemId}/groups:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups"
/systems/{systemId}/groups/tree:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1tree"
/systems/{systemId}/groups/reorder:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1reorder"
/systems/{systemId}/groups/{groupId}:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D"
/systems/{systemId}/groups/{groupId}/move:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D~1move"
/systems/{systemId}/groups/{groupId}/copy:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D~1copy"
/systems/{systemId}/groups/{groupId}/archive:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D~1archive"
/systems/{systemId}/groups/{groupId}/restore:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D~1restore"
/systems/{systemId}/groups/{groupId}/members:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D~1members"
/systems/{systemId}/groups/{groupId}/members/{memberId}:
$ref: "./paths/groups.yaml#/~1systems~1%7BsystemId%7D~1groups~1%7BgroupId%7D~1members~1%7BmemberId%7D"
# Custom Fronts
/systems/{systemId}/custom-fronts:
$ref: "./paths/custom-fronts.yaml#/~1systems~1%7BsystemId%7D~1custom-fronts"
/systems/{systemId}/custom-fronts/{customFrontId}:
$ref: "./paths/custom-fronts.yaml#/~1systems~1%7BsystemId%7D~1custom-fronts~1%7BcustomFrontId%7D"
/systems/{systemId}/custom-fronts/{customFrontId}/archive:
$ref: "./paths/custom-fronts.yaml#/~1systems~1%7BsystemId%7D~1custom-fronts~1%7BcustomFrontId%7D~1archive"
/systems/{systemId}/custom-fronts/{customFrontId}/restore:
$ref: "./paths/custom-fronts.yaml#/~1systems~1%7BsystemId%7D~1custom-fronts~1%7BcustomFrontId%7D~1restore"
# Device Tokens
/systems/{systemId}/device-tokens:
$ref: "./paths/device-tokens.yaml#/~1systems~1%7BsystemId%7D~1device-tokens"
/systems/{systemId}/device-tokens/{tokenId}:
$ref: "./paths/device-tokens.yaml#/~1systems~1%7BsystemId%7D~1device-tokens~1%7BtokenId%7D"
/systems/{systemId}/device-tokens/{tokenId}/revoke:
$ref: "./paths/device-tokens.yaml#/~1systems~1%7BsystemId%7D~1device-tokens~1%7BtokenId%7D~1revoke"
# Notification Configs
/systems/{systemId}/notification-configs:
$ref: "./paths/notification-configs.yaml#/~1systems~1%7BsystemId%7D~1notification-configs"
/systems/{systemId}/notification-configs/{eventType}:
$ref: "./paths/notification-configs.yaml#/~1systems~1%7BsystemId%7D~1notification-configs~1%7BeventType%7D"
# Field Definitions
/systems/{systemId}/fields:
$ref: "./paths/fields.yaml#/~1systems~1%7BsystemId%7D~1fields"
/systems/{systemId}/fields/{fieldId}:
$ref: "./paths/fields.yaml#/~1systems~1%7BsystemId%7D~1fields~1%7BfieldId%7D"
/systems/{systemId}/fields/{fieldId}/archive:
$ref: "./paths/fields.yaml#/~1systems~1%7BsystemId%7D~1fields~1%7BfieldId%7D~1archive"
/systems/{systemId}/fields/{fieldId}/restore:
$ref: "./paths/fields.yaml#/~1systems~1%7BsystemId%7D~1fields~1%7BfieldId%7D~1restore"
# Field Bucket Visibility
/systems/{systemId}/fields/{fieldDefinitionId}/bucket-visibility:
$ref: "./paths/fields.yaml#/~1systems~1%7BsystemId%7D~1fields~1%7BfieldDefinitionId%7D~1bucket-visibility"
/systems/{systemId}/fields/{fieldDefinitionId}/bucket-visibility/{bucketId}:
$ref: "./paths/fields.yaml#/~1systems~1%7BsystemId%7D~1fields~1%7BfieldDefinitionId%7D~1bucket-visibility~1%7BbucketId%7D"
# Relationships
/systems/{systemId}/relationships:
$ref: "./paths/relationships.yaml#/~1systems~1%7BsystemId%7D~1relationships"
/systems/{systemId}/relationships/{relationshipId}:
$ref: "./paths/relationships.yaml#/~1systems~1%7BsystemId%7D~1relationships~1%7BrelationshipId%7D"
/systems/{systemId}/relationships/{relationshipId}/archive:
$ref: "./paths/relationships.yaml#/~1systems~1%7BsystemId%7D~1relationships~1%7BrelationshipId%7D~1archive"
/systems/{systemId}/relationships/{relationshipId}/restore:
$ref: "./paths/relationships.yaml#/~1systems~1%7BsystemId%7D~1relationships~1%7BrelationshipId%7D~1restore"
# Structure Entity Types
/systems/{systemId}/structure/entity-types:
$ref: "./paths/structure-entity-types.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-types"
/systems/{systemId}/structure/entity-types/{entityTypeId}:
$ref: "./paths/structure-entity-types.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-types~1%7BentityTypeId%7D"
/systems/{systemId}/structure/entity-types/{entityTypeId}/archive:
$ref: "./paths/structure-entity-types.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-types~1%7BentityTypeId%7D~1archive"
/systems/{systemId}/structure/entity-types/{entityTypeId}/restore:
$ref: "./paths/structure-entity-types.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-types~1%7BentityTypeId%7D~1restore"
# Structure Entities
/systems/{systemId}/structure/entities:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entities"
/systems/{systemId}/structure/entities/{entityId}:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entities~1%7BentityId%7D"
/systems/{systemId}/structure/entities/{entityId}/archive:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entities~1%7BentityId%7D~1archive"
/systems/{systemId}/structure/entities/{entityId}/restore:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entities~1%7BentityId%7D~1restore"
# Structure Entity Links
/systems/{systemId}/structure/entity-links:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-links"
/systems/{systemId}/structure/entity-links/{linkId}:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-links~1%7BlinkId%7D"
# Structure Entity Member Links
/systems/{systemId}/structure/entity-member-links:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-member-links"
/systems/{systemId}/structure/entity-member-links/{linkId}:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-member-links~1%7BlinkId%7D"
# Structure Entity Associations
/systems/{systemId}/structure/entity-associations:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-associations"
/systems/{systemId}/structure/entity-associations/{associationId}:
$ref: "./paths/structure-entities.yaml#/~1systems~1%7BsystemId%7D~1structure~1entity-associations~1%7BassociationId%7D"
# Lifecycle Events
/systems/{systemId}/lifecycle-events:
$ref: "./paths/lifecycle-events.yaml#/~1systems~1%7BsystemId%7D~1lifecycle-events"
/systems/{systemId}/lifecycle-events/{eventId}:
$ref: "./paths/lifecycle-events.yaml#/~1systems~1%7BsystemId%7D~1lifecycle-events~1%7BeventId%7D"
# Innerworld
/systems/{systemId}/innerworld/regions:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1regions"
/systems/{systemId}/innerworld/regions/{regionId}:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1regions~1%7BregionId%7D"
/systems/{systemId}/innerworld/regions/{regionId}/archive:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1regions~1%7BregionId%7D~1archive"
/systems/{systemId}/innerworld/regions/{regionId}/restore:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1regions~1%7BregionId%7D~1restore"
/systems/{systemId}/innerworld/entities:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1entities"
/systems/{systemId}/innerworld/entities/{entityId}:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1entities~1%7BentityId%7D"
/systems/{systemId}/innerworld/entities/{entityId}/archive:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1entities~1%7BentityId%7D~1archive"
/systems/{systemId}/innerworld/entities/{entityId}/restore:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1entities~1%7BentityId%7D~1restore"
/systems/{systemId}/innerworld/canvas:
$ref: "./paths/innerworld.yaml#/~1systems~1%7BsystemId%7D~1innerworld~1canvas"
# Blobs
/systems/{systemId}/blobs:
$ref: "./paths/blobs.yaml#/~1systems~1%7BsystemId%7D~1blobs"
/systems/{systemId}/blobs/upload-url:
$ref: "./paths/blobs.yaml#/~1systems~1%7BsystemId%7D~1blobs~1upload-url"
/systems/{systemId}/blobs/{blobId}/confirm:
$ref: "./paths/blobs.yaml#/~1systems~1%7BsystemId%7D~1blobs~1%7BblobId%7D~1confirm"
/systems/{systemId}/blobs/{blobId}/download-url:
$ref: "./paths/blobs.yaml#/~1systems~1%7BsystemId%7D~1blobs~1%7BblobId%7D~1download-url"
/systems/{systemId}/blobs/{blobId}:
$ref: "./paths/blobs.yaml#/~1systems~1%7BsystemId%7D~1blobs~1%7BblobId%7D"
# Buckets
/systems/{systemId}/buckets:
$ref: "./paths/buckets.yaml#/~1systems~1%7BsystemId%7D~1buckets"
/systems/{systemId}/buckets/{bucketId}:
$ref: "./paths/buckets.yaml#/~1systems~1%7BsystemId%7D~1buckets~1%7BbucketId%7D"
/systems/{systemId}/buckets/{bucketId}/archive:
$ref: "./paths/buckets.yaml#/~1systems~1%7BsystemId%7D~1buckets~1%7BbucketId%7D~1archive"
/systems/{systemId}/buckets/{bucketId}/restore:
$ref: "./paths/buckets.yaml#/~1systems~1%7BsystemId%7D~1buckets~1%7BbucketId%7D~1restore"
/systems/{systemId}/buckets/{bucketId}/tags:
$ref: "./paths/buckets.yaml#/~1systems~1%7BsystemId%7D~1buckets~1%7BbucketId%7D~1tags"