Skip to content

Commit 2a4be93

Browse files
committed
Create chunking.rs
1 parent 84f1c23 commit 2a4be93

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

docs/openAPI.yaml

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,17 @@ paths:
6464
# ============================================================================
6565

6666
/:
67+
head:
68+
tags:
69+
- Control Plane
70+
summary: HealthCheck
71+
operationId: healthCheck
72+
description: Check if the gateway is healthy and accepting requests
73+
security: []
74+
responses:
75+
'200':
76+
description: Gateway is healthy
77+
6778
get:
6879
tags:
6980
- Bucket Operations
@@ -297,12 +308,15 @@ paths:
297308
298309
**Encryption Flow**:
299310
1. Client encrypts data with HPKE (keys never sent to server)
300-
2. Client chunks encrypted data (256KB blocks)
301-
3. Client uploads blocks to gateway
311+
2. Client chunks encrypted data (768KB max per chunk, under IPFS 1MB limit)
312+
3. Client uploads chunks to gateway (automatic for files >768KB)
302313
4. Gateway pins to IPFS Cluster
303314
5. Gateway updates Prolly Tree index
304315
305316
**Max Size**: 5GB for single PUT (use multipart for larger files)
317+
318+
**Chunked Files**: Files >768KB are automatically split into chunks by the client.
319+
The `x-fula-chunked: true` header indicates a chunked file manifest.
306320
security:
307321
- oauth2: [storage:write]
308322
parameters:
@@ -360,6 +374,15 @@ paths:
360374
schema:
361375
type: string
362376
format: json
377+
- name: x-fula-chunked
378+
in: header
379+
description: |
380+
Indicates this object is a chunked file manifest (for files >768KB).
381+
The manifest contains chunk CIDs and metadata for reassembly.
382+
Value: "true"
383+
schema:
384+
type: string
385+
enum: ["true"]
363386
- name: x-fula-forest
364387
in: header
365388
description: |

0 commit comments

Comments
 (0)