Skip to content

docs: add /api/upload (Arweave file upload)#178

Open
arpitgupta1214 wants to merge 2 commits intomainfrom
migrate/upload-group2
Open

docs: add /api/upload (Arweave file upload)#178
arpitgupta1214 wants to merge 2 commits intomainfrom
migrate/upload-group2

Conversation

@arpitgupta1214
Copy link
Copy Markdown
Collaborator

@arpitgupta1214 arpitgupta1214 commented Apr 28, 2026

Documents the new dedicated POST /api/upload endpoint on api which is parity for chat's /api/upload (group 2 of the chat→api migration). Adds an Upload group under the Content tab.

Test plan

  • npx mintlify@latest dev renders the new "Upload File" page under Content → Upload
  • OpenAPI request/response schemas match the runtime shape on api

Summary by cubic

Adds docs for the POST /api/upload endpoint for Arweave file uploads, matching chat’s upload. Adds an Upload group under Content.

  • New Features
    • OpenAPI spec for POST /api/upload with multipart file field and 200/500 response schemas.
    • New "Upload File" page wired to the spec; notes no auth and returns an HTTPS Arweave gateway URL.

Written for commit c879be5. Summary will update on new commits.

Documents the new dedicated `POST /api/upload` endpoint on api which is
parity for chat's `/api/upload`. Adds an "Upload" group under the
Content tab.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Warning

Rate limit exceeded

@arpitgupta1214 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 59 minutes and 53 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0aee63cb-6039-4e48-8ce7-df5a111b3f1f

📥 Commits

Reviewing files that changed from the base of the PR and between 8cdd415 and c879be5.

📒 Files selected for processing (3)
  • api-reference/openapi/upload.json
  • api-reference/upload/file.mdx
  • docs.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch migrate/upload-group2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="api-reference/openapi/upload.json">

<violation number="1" location="api-reference/openapi/upload.json:49">
P2: Document missing-file validation as a 400-level error instead of a 500 response.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

}
}
},
"500": {
Copy link
Copy Markdown

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
Check if this issue is valid — if so, understand the root cause and fix it. At api-reference/openapi/upload.json, line 49:

<comment>Document missing-file validation as a 400-level error instead of a 500 response.</comment>

<file context>
@@ -0,0 +1,123 @@
+              }
+            }
+          },
+          "500": {
+            "description": "Upload failed (no file provided or Arweave error)",
+            "content": {
</file context>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant