Skip to content

Commit c275d9b

Browse files
author
hackpulsar
committed
refine api docs and title
1 parent d05ba6b commit c275d9b

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Storage Crab API
1+
# 🦀 Storage Crab API
22

33
A Rust-based backend API for file storage with sharing capabilities.
44

docs/api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
// Content-Type: multipart/form-data
6969
// Form fields:
7070
// - file: <binary>
71-
// - json: {"filename": "document.pdf"}
71+
// - json: {"filename": "document.pdf.enc"}
7272
```
7373

7474
### Refresh Token
@@ -111,8 +111,8 @@ Welcome back, johndoe
111111
[
112112
{
113113
"id": 1,
114-
"filename": "document.pdf",
115-
"path": "/app/files_storage/abc123/document.pdf",
114+
"filename": "document.pdf.enc",
115+
"path": "/app/files_storage/<username_hash>/document.pdf.enc",
116116
"size": 1024000,
117117
"uploaded_at": "2024-01-15T10:30:00",
118118
"user_id": 1
@@ -125,7 +125,7 @@ Welcome back, johndoe
125125
// GET /api/files/download/{file_id}/
126126
// Response: binary file stream
127127
// Headers:
128-
// - Content-Disposition: attachment; filename="document.pdf"
128+
// - Content-Disposition: attachment; filename="document.pdf.enc"
129129
// - Content-Length: 1024000
130130
```
131131

@@ -140,7 +140,7 @@ Welcome back, johndoe
140140
// GET /api/files/download/shared/{share_code}/
141141
// Response: binary file stream (no auth required)
142142
// Headers:
143-
// - Content-Disposition: attachment; filename="document.pdf"
143+
// - Content-Disposition: attachment; filename="document.pdf.enc"
144144
// - Content-Length: 1024000
145145
```
146146

0 commit comments

Comments
 (0)