feat(docs): add POST /api/upload endpoint reference

AR
5mo ago
+173-0

Summary

Adds API-reference documentation for POST /api/upload (the new file-upload endpoint on recoup-api.vercel.app). Includes the OpenAPI spec, the auto-generated MDX page, and the navigation entry under Content → Upload.

The endpoint accepts a single multipart file and returns { success, fileName, fileType, fileSize, url } with a permanent CDN-fronted HTTPS URL.

Test plan

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

Summary by cubic

Adds API-reference docs for POST /api/upload on recoup-api.vercel.app. Requires auth (Bearer token or x-api-key) and shows how to upload a single multipart file to get a permanent HTTPS URL with { success, fileName, fileType, fileSize, url }.

  • New Features
    • Added OpenAPI 3.1 spec with global security only (primary apiKeyAuth, then bearerAuth) and aligned auth scheme with sandbox/sessions (removed bearerFormat and vendor-specific text).
    • Clarified status codes: 400 (malformed/missing file), 401 (auth), 415 (unsupported/typeless MIME), 500 (internal).
    • Documented that storage metadata includes uploaded_by with the caller’s accountId.
    • Generated MDX page api-reference/upload/file and added an "Upload" group under Content; using the spec’s default servers.

Summary by CodeRabbit

Release Notes

  • New Features

    • Added file upload API endpoint supporting authenticated file submissions via bearer token or API key authentication.

  • Documentation

    • Published API reference documentation for the file upload endpoint, including request formats, response schemas, and error handling.

Review Change Stack