-
Notifications
You must be signed in to change notification settings - Fork 3
docs: add /api/upload (Arweave file upload) #178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arpitgupta1214
wants to merge
2
commits into
main
Choose a base branch
from
migrate/upload-group2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+133
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| { | ||
| "openapi": "3.1.0", | ||
| "info": { | ||
| "title": "Recoup API - Upload", | ||
| "description": "API documentation for the Recoup platform - an AI agent platform for the music industry", | ||
| "license": { | ||
| "name": "MIT" | ||
| }, | ||
| "version": "1.0.0" | ||
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "https://recoup-api.vercel.app" | ||
| } | ||
| ], | ||
| "paths": { | ||
| "/api/upload": { | ||
| "post": { | ||
| "description": "Uploads a file to the Arweave permanent storage network and returns a fetchable HTTPS gateway URL. Accepts a single file via multipart/form-data under the field name `file`. No authentication required.", | ||
| "requestBody": { | ||
| "required": true, | ||
| "content": { | ||
| "multipart/form-data": { | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["file"], | ||
| "properties": { | ||
| "file": { | ||
| "type": "string", | ||
| "format": "binary", | ||
| "description": "The file bytes to upload." | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "description": "File uploaded successfully", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/UploadResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "500": { | ||
| "description": "Upload failed (no file provided or Arweave error)", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/UploadErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "UploadResponse": { | ||
| "type": "object", | ||
| "required": [ | ||
| "success", | ||
| "fileName", | ||
| "fileType", | ||
| "fileSize", | ||
| "url" | ||
| ], | ||
| "properties": { | ||
| "success": { | ||
| "type": "boolean", | ||
| "description": "Always `true` on a 200 response.", | ||
| "example": true | ||
| }, | ||
| "fileName": { | ||
| "type": "string", | ||
| "description": "The original file name from the upload.", | ||
| "example": "cover.png" | ||
| }, | ||
| "fileType": { | ||
| "type": "string", | ||
| "description": "The MIME type of the uploaded file. Falls back to `application/octet-stream` if the client did not provide one.", | ||
| "example": "image/png" | ||
| }, | ||
| "fileSize": { | ||
| "type": "integer", | ||
| "description": "The size of the uploaded file in bytes.", | ||
| "example": 24576 | ||
| }, | ||
| "url": { | ||
| "type": "string", | ||
| "description": "Fetchable HTTPS Arweave gateway URL.", | ||
| "example": "https://arweave.net/abc123" | ||
| } | ||
| } | ||
| }, | ||
| "UploadErrorResponse": { | ||
| "type": "object", | ||
| "required": [ | ||
| "success", | ||
| "error" | ||
| ], | ||
| "properties": { | ||
| "success": { | ||
| "type": "boolean", | ||
| "description": "Always `false` on an error response.", | ||
| "example": false | ||
| }, | ||
| "error": { | ||
| "type": "string", | ||
| "description": "Error message describing what went wrong.", | ||
| "example": "No file provided" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: 'Upload File' | ||
| openapi: '/api-reference/openapi/upload.json POST /api/upload' | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: Document missing-file validation as a 400-level error instead of a 500 response.
Prompt for AI agents