Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2113 lines (2111 loc) · 60.4 KB
/
Copy pathopenapi.yaml
File metadata and controls
2113 lines (2111 loc) · 60.4 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.0.3
info:
title: Virtual Tour POC API
version: 0.8.0
servers:
- url: http://localhost:8080
paths:
/api/v1/capabilities:
get:
summary: Read runtime Gaussian splat rollout capabilities
description: No-store response. Browser build and runtime capabilities must both permit support. Disabled support preserves scene metadata and returns 503 for splat signing or new admission.
responses:
'200':
description: Runtime capabilities
content:
application/json:
schema:
type: object
required: [splat_viewer, splat_authoring]
properties:
splat_viewer:
type: boolean
splat_authoring:
type: boolean
splat_walking:
type: boolean
splat_streaming:
type: boolean
/health:
get:
summary: Check database health
responses:
'200':
description: Healthy
'503':
description: Database unavailable
/api/v1/assets/{id}/splat-tiles:
get:
summary: Read a ready exact-record splat tile manifest
description: Requires ready SPLAT parent and enabled streaming. Source/hash/attempt identity is immutable; private bucket keys are omitted. Public equivalents under /public/tours/{slug}/assets/{id}/splat-tiles additionally recheck publication and actual parent references.
parameters:
- in: path
name: id
required: true
schema: {type: string, format: uuid}
- in: query
name: source_sha256
schema: {type: string}
responses:
'200': {description: Versioned splat-tiles-v1 manifest with bounded counts and corrected conservative tile bounds}
'404': {description: Disabled or not ready}
'409': {description: Source identity changed}
/api/v1/assets/{id}/splat-tiles/{tile}:
get:
summary: Sign one verified splat tile payload
parameters:
- in: path
name: id
required: true
schema: {type: string, format: uuid}
- in: path
name: tile
required: true
schema: {type: string, pattern: '^tile-[0-9]{3}$'}
- in: query
name: source_sha256
schema: {type: string}
responses:
'200': {description: Scoped signed URL plus expected SHA-256, bytes and source SHA-256}
'404': {description: Parent unavailable or tile unknown}
'409': {description: Source identity changed}
/api/v1/projects:
get:
summary: List projects, newest first
responses:
'200':
description: Projects
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project'
'500':
$ref: '#/components/responses/Error'
post:
summary: Create a project
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProjectInput'
- required:
- name
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'400':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/api/v1/projects/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
get:
summary: Read a project
responses:
'200':
description: Project
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
patch:
summary: Update name and/or description
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPatch'
responses:
'200':
description: Updated project
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
delete:
summary: Delete a project
responses:
'204':
description: Deleted
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/api/v1/projects/{id}/uploads:
parameters: &id001
- name: id
in: path
required: true
schema: &id016
type: string
format: uuid
post:
summary: Start a GLB, raw SPLAT, panorama or information image upload
responses:
'201':
description: Start a size-limited model, splat or image upload
content:
application/json:
schema:
$ref: '#/components/schemas/UploadTicket'
'400': &id002
$ref: '#/components/responses/Error'
'404': &id003
$ref: '#/components/responses/Error'
'500': &id004
$ref: '#/components/responses/Error'
'503': &id005
$ref: '#/components/responses/Error'
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- name
- size
properties:
name:
type: string
maxLength: 120
description: Filename ending in .glb, .splat, .jpg, .jpeg, .png or .webp,
without path separators
size:
type: integer
minimum: 20
maximum: 1048576000
description: GLB limit is 1000 MiB; PANORAMA and IMAGE limit is
100 MiB. SPLAT uses raw 32-byte records, at most 2,000,000 records / 64,000,000 bytes.
file_type:
type: string
enum:
- GLB
- SPLAT
- PANORAMA
- IMAGE
- TEXTURE_BASE_COLOR
- TEXTURE_NORMAL
- TEXTURE_ROUGHNESS
description: Defaults to GLB for .glb, SPLAT for .splat, PANORAMA for images. Choose
IMAGE for hotspot images without a 2:1 requirement. Choose a TEXTURE_*
role for a material map without a 2:1 requirement. Base color
is sRGB; normal/roughness are linear data. Images are limited
to 8192 × 4096 pixels.
description: POST multipart form data directly to upload.url, with every upload.fields
entry and the file field last. The policy expires after 15 minutes and requires
the exact declared file size. Then call the completion endpoint.
/api/v1/projects/{id}/assets:
parameters: *id001
get:
summary: List project assets
responses:
'200':
description: List project assets
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Asset'
'400': *id002
'404': *id003
'500': *id004
'503': *id005
/api/v1/assets/{id}:
parameters: *id001
get:
summary: Get asset metadata and a fresh read URL
responses:
'200':
description: Get asset metadata and a fresh read URL
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Asset'
- type: object
properties:
url:
type: string
description: 15-minute presigned URL when ready; empty while
pending
'400': *id002
'404': *id003
'500': *id004
'503': *id005
delete:
summary: Delete asset metadata; originals remain in storage
responses:
'204':
description: Deleted
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
'409':
description: Asset is still used by a scene
content:
application/json:
schema:
type: object
properties:
error:
type: string
/api/v1/assets/{id}/complete:
parameters: *id001
post:
summary: Validate upload and confirm completion
responses:
'200':
description: Validate upload and confirm completion
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
'400': *id002
'404': *id003
'500': *id004
'503': *id005
'422':
$ref: '#/components/responses/Error'
description: Checks size and validates GLB v2 framing/embedded resources or
panorama format, 2:1 dimensions (up to 8192 × 4096) and fully decoded pixels.
SPLAT validates the exact splat-v1 profile with finite positions, positive linear scales,
RGBA bytes and quantized unit rotations (maximum 2,000,000 records). Splat inspection
has a 30-second timeout and two concurrent slots; immutable conditional promotion
preserves the inspected bytes across retries. Idempotent once ready. Body is
not required.
/api/v1/projects/{id}/scenes:
parameters: *id001
get:
summary: List project scenes in order
responses:
'200':
description: List project scenes in order
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Scene'
'400': *id002
'404': *id003
'500': *id004
'503': *id005
post:
summary: Create an imported scene or a continuous layout scene
responses:
'201':
description: Create a scene from a ready asset in the same project
content:
application/json:
schema:
$ref: '#/components/schemas/Scene'
'400': *id002
'404': *id003
'500': *id004
'503': *id005
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
additionalProperties: false
required:
- asset_id
- name
properties:
asset_id: &id020
type: string
format: uuid
name:
type: string
minLength: 1
maxLength: 120
- type: object
additionalProperties: false
required:
- type
- name
properties:
type:
type: string
enum:
- LAYOUT
name:
type: string
minLength: 1
maxLength: 120
layout:
$ref: '#/components/schemas/LayoutDocument'
description: Maximum JSON body 256 KiB. LAYOUT scenes omit asset_id; an omitted
layout starts with empty elements/doors. The scene and instance references
are created atomically. Imported scenes infer 3D from ready GLB, SPLAT from ready raw splat-v1 or PANORAMA from ready panorama assets; other asset roles and cross-project or pending sources are rejected.
/api/v1/scenes/{id}:
parameters: *id001
get:
summary: Get a scene
responses:
'200':
description: Get a scene
content:
application/json:
schema:
$ref: '#/components/schemas/Scene'
'400': *id002
'404': *id003
'500': *id004
'503': *id005
patch:
summary: Rename, move or save scene start view
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScenePatch'
responses:
'200':
description: Scene with saved start view
content:
application/json:
schema:
$ref: '#/components/schemas/Scene'
'400': *id002
'404': *id003
'500': *id004
delete:
summary: Delete a scene and its incoming/outgoing navigation links; replace
its start-scene setting
responses:
'204':
description: Deleted
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/api/v1/scenes/{id}/hotspots:
parameters: &id006
- name: id
in: path
required: true
schema:
type: string
format: uuid
get:
summary: List scene hotspots
responses:
'200':
description: Hotspot array
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Hotspot'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
post:
summary: Create a NAVIGATION or INFO hotspot
requestBody: &id007
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NavigationInput'
responses:
'201':
description: Saved hotspot
content:
application/json:
schema:
$ref: '#/components/schemas/Hotspot'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/api/v1/hotspots/{id}:
parameters: *id006
delete:
summary: Delete a hotspot
responses:
'204':
description: Deleted
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
patch:
summary: Save complete hotspot content and/or reposition it
requestBody: *id007
responses:
'200':
description: Updated hotspot
content:
application/json:
schema:
$ref: '#/components/schemas/Hotspot'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
/api/v1/projects/{id}/publish:
parameters:
- &id009
name: id
in: path
required: true
schema:
type: string
format: uuid
post:
summary: Publish the saved tour
responses:
'200':
description: Saved publication state
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'400': &id008
$ref: '#/components/responses/Error'
'404': *id008
'500': *id008
description: Requires at least one usable scene, a valid start scene, completed
scene/image assets and valid navigation destinations. Publishing and repeated
publishing preserve the slug. Saved edits appear immediately; no snapshots.
/api/v1/projects/{id}/unpublish:
parameters:
- *id009
post:
summary: Unpublish the saved tour
responses:
'200':
description: Saved publication state
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'400': *id008
'404': *id008
'500': *id008
/api/v1/public/tours/{slug}:
parameters:
- &id010
name: slug
in: path
required: true
schema:
type: string
get:
summary: Read a published saved tour
description: '404 for unpublished or unknown slugs. No storage keys or asset
URLs are exposed in metadata. Fetch fresh URLs through the tour-scoped asset
endpoint on scene load. Responses use Cache-Control: no-store.'
responses:
'200':
description: Tour metadata
content:
application/json:
schema:
$ref: '#/components/schemas/PublicTour'
'404': *id008
'500': *id008
/api/v1/public/tours/{slug}/assets/{id}:
parameters:
- *id010
- *id009
get:
summary: Get a fresh read URL for an asset used by this published tour
description: 'Only completed assets referenced by a scene or information hotspot
in this tour are accessible. Unpublished tours, unused assets and other-project
assets return 404. Response uses Cache-Control: no-store.'
responses:
'200':
description: Browser-reachable presigned read URL
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
format: uri
'400': *id008
'404': *id008
'503': *id008
/api/v1/public/tours/{slug}/scenes/{id}/hotspots:
parameters:
- *id010
- *id009
get:
summary: Read hotspots for a scene in this published tour
description: 'Unknown/unpublished tours and scenes outside the tour return 404.
Response uses Cache-Control: no-store.'
responses:
'200':
description: Scene hotspots
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Hotspot'
'400': *id008
'404': *id008
'500': *id008
/api/v1/scenes/{id}/layout:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
get:
summary: Get a saved layout document and revision
responses:
'200':
description: LayoutRead
content:
application/json:
schema:
$ref: '#/components/schemas/LayoutRead'
'400': &id011
$ref: '#/components/responses/Error'
'404': &id012
$ref: '#/components/responses/Error'
'409': &id013
$ref: '#/components/responses/Error'
'500': &id014
$ref: '#/components/responses/Error'
'503': &id015
$ref: '#/components/responses/Error'
put:
summary: Save a whole layout atomically with a revision check
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LayoutSave'
responses:
'200':
description: Scene
content:
application/json:
schema:
$ref: '#/components/schemas/Scene'
'400': *id011
'404': *id012
'409': *id013
'500': *id014
'503': *id015
/api/v1/public/tours/{slug}/scenes/{id}/layout:
parameters:
- name: slug
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
format: uuid
get:
summary: Read a published tour-scoped layout
responses:
'200':
description: LayoutRead
content:
application/json:
schema:
$ref: '#/components/schemas/LayoutRead'
'400': *id011
'404': *id012
'409': *id013
'500': *id014
'503': *id015
/api/v1/assets/{id}/partition:
parameters:
- in: path
name: id
required: true
schema: {type: string, format: uuid}
get:
summary: Read author-reviewed source ownership or complete-original fallback
description: Private parent-asset lookup. No chunk output is advertised. See chunking-contracts.md and chunking.schema.json for the strict contracts.
responses:
'200':
description: Revision, source inventory and partition document; inventory/document are null before inspection
'404':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
put:
summary: Save source-bound partition review with revision compare-and-swap
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required: [revision, source_sha256, document]
properties:
revision: {type: integer, minimum: 0}
source_sha256: {type: string, pattern: '^[a-f0-9]{64}$'}
document:
type: object
description: Strict partition-v1 document; validated against authoritative original inventory (see chunking.schema.json)
responses:
'200':
description: Saved partition and incremented revision
'400':
$ref: '#/components/responses/Error'
'409':
description: Stale partition/source revision or inventory not prepared
/api/v1/assets/{id}/partition/inventory:
parameters:
- in: path
name: id
required: true
schema: {type: string, format: uuid}
post:
summary: Inspect immutable original GLB source for author review
description: Requires completed GLB, configured processor and storage download support. Bounded to 256 MiB, two minutes and one inspection per API process. Same-source refresh preserves existing author edits.
responses:
'200':
description: Original source inventory and current revisioned partition review
'422':
description: Unsupported/oversized source, timeout or invalid inventory; complete original remains available
'429':
description: Another source inspection is running
'502':
description: Original source could not be read
'503':
$ref: '#/components/responses/Error'
/api/v1/assets/{id}/chunks:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: revision
in: query
schema:
type: integer
minimum: 1
- name: source_sha256
in: query
schema:
type: string
get:
summary: Read current bounded chunk manifest
description: Manifest payload URLs return JSON descriptors. Every refresh resolves only IDs in the current validated parent manifest; storage keys are never accepted.
responses:
'200':
description: Current scoped metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ScopedChunkManifest'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
/api/v1/assets/{id}/chunks/{chunk}:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: chunk
in: path
required: true
schema:
type: string
- name: revision
in: query
schema:
type: integer
minimum: 1
- name: source_sha256
in: query
schema:
type: string
- name: tier
in: query
schema:
type: string
enum: [low, balanced, hq]
default: balanced
get:
summary: Sign a current chunk payload
description: Manifest payload URLs return JSON descriptors. Every refresh resolves only IDs in the current validated parent manifest; storage keys are never accepted.
responses:
'200':
description: Current scoped metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ChunkPayloadDescriptor'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
/api/v1/assets/{id}/chunk-indexes/{index}:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: index
in: path
required: true
schema:
type: string
- name: revision
in: query
schema:
type: integer
minimum: 1
- name: source_sha256
in: query
schema:
type: string
get:
summary: Sign exact navigation or authored occlusion
description: Manifest payload URLs return JSON descriptors. Every refresh resolves only IDs in the current validated parent manifest; storage keys are never accepted.
responses:
'200':
description: Current scoped metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ChunkPayloadDescriptor'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
/api/v1/assets/{id}/chunk-dependencies/{dependency}:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: dependency
in: path
required: true
schema:
type: string
- name: revision
in: query
schema:
type: integer
minimum: 1
- name: source_sha256
in: query
schema:
type: string
- name: tier
in: query
schema:
type: string
enum: [low, balanced, hq]
default: balanced
get:
summary: Sign a declared shared dependency
description: Manifest payload URLs return JSON descriptors. Every refresh resolves only IDs in the current validated parent manifest; storage keys are never accepted.
responses:
'200':
description: Current scoped metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ChunkPayloadDescriptor'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
/api/v1/public/tours/{slug}/assets/{id}/chunks:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: slug
in: path
required: true
schema:
type: string
- name: revision
in: query
schema:
type: integer
minimum: 1
- name: source_sha256
in: query
schema:
type: string
get:
summary: Read current bounded chunk manifest
description: Published tour reference to a ready parent is required. Manifest payload URLs return JSON descriptors. Every refresh resolves only IDs in the current validated parent manifest; storage keys are never accepted.
responses:
'200':
description: Current scoped metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ScopedChunkManifest'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
/api/v1/public/tours/{slug}/assets/{id}/chunks/{chunk}:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: slug
in: path
required: true
schema:
type: string
- name: chunk
in: path
required: true
schema:
type: string
- name: revision
in: query
schema:
type: integer
minimum: 1
- name: source_sha256
in: query
schema:
type: string
- name: tier
in: query
schema:
type: string
enum: [low, balanced, hq]
default: balanced
get:
summary: Sign a current chunk payload
description: Published tour reference to a ready parent is required. Manifest payload URLs return JSON descriptors. Every refresh resolves only IDs in the current validated parent manifest; storage keys are never accepted.
responses:
'200':
description: Current scoped metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ChunkPayloadDescriptor'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'503':
$ref: '#/components/responses/Error'
/api/v1/public/tours/{slug}/assets/{id}/chunk-indexes/{index}:
parameters:
- name: id
in: path