Charter Captain Uploads API

openapi: 3.2.0
info:
  title: Charter Captain Uploads API
  version: 1.0.0
  description: REST API for the Charter Captain iOS apps
servers:
- url: http://localhost:3002
  description: Development
security:
- bearerAuth: []
tags:
- name: Uploads
paths:
  /api/v1/uploads/sign:
    post:
      operationId: postUploadSign
      summary: Mint a Vercel Blob client token for a direct image upload
      description: Returns a short-lived token (1h) the iOS client uses with @vercel/blob to upload a single image. Bypasses Vercel's 4.5MB function body limit. The completion webhook fires at /api/v1/uploads/complete and persists the URL to the appropriate Prisma model based on `kind`.
      tags:
      - Uploads
      parameters:
      - schema:
          type: string
          format: uuid
        required: false
        name: idempotency-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignUpload'
      responses:
        '201':
          description: Client token minted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SignUploadResponse'
                required:
                - data
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/IdempotencyConflict'
  /api/v1/uploads/complete:
    post:
      operationId: postUploadComplete
      summary: Vercel Blob upload-completed webhook
      description: Called by Vercel Blob after a client upload finishes. Signature verification is delegated to @vercel/blob/client.handleUpload. iOS clients do NOT call this endpoint — it's documented here for completeness only.
      tags:
      - Uploads
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlobWebhookBody'
      responses:
        '200':
          description: Webhook handled
        '400':
          description: Invalid body, malformed clientPayload, or persistence failure
components:
  schemas:
    BlobWebhookBody:
      type: object
      properties:
        type:
          type: string
          enum:
          - blob.generate-client-token
          - blob.upload-completed
          description: Vercel Blob event type. Set by the Vercel Blob service; not authored by clients of the Charter Captain API.
      required:
      - type
      additionalProperties: {}
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
          - message
          - code
      required:
      - error
    SignUpload:
      type: object
      properties:
        contentType:
          type: string
          pattern: ^image\/(jpeg|png|heic|webp)$
        sizeBytes:
          type: integer
          minimum: 1
          maximum: 52428800
        kind:
          type: string
          enum:
          - boat-photo
          - profile
          - gallery
          - booking-attachment
        refId:
          type:
          - string
          - 'null'
      required:
      - contentType
      - sizeBytes
      - kind
    SignUploadResponse:
      type: object
      properties:
        token:
          type: string
        blobUrl:
          type: string
          format: uri
        pathname:
          type: string
      required:
      - token
      - blobUrl
      - pathname
    IdempotencyConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
              enum:
              - IDEMPOTENCY_CONFLICT
          required:
          - message
          - code
      required:
      - error
  responses:
    NotFound:
      description: The requested resource does not exist (existence is not leaked).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required, or the bearer token is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not permitted to access this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Request body or query parameters failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    IdempotencyConflict:
      description: Idempotency-Key was reused with a different request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IdempotencyConflictError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk JWT token