dialogbrain-com Workspace Storage API

openapi: 3.2.0
info:
  title: DialogBrain v2 API Gateway Workspace Storage API
  description: Clean refactored API gateway with minimal vertical slice
  version: 0.1.0
tags:
- name: workspace-storage
paths:
  /api/workspace/storage/orphans:
    get:
      tags:
      - workspace-storage
      summary: Preview Orphans
      description: 'Preview every orphan file the cleanup would delete.


        No side effects. Members can view the preview (so a non-owner can

        see what would happen before asking the owner to run cleanup).'
      operationId: preview_orphans_api_workspace_storage_orphans_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrphanPreview'
  /api/workspace/storage/orphans/cleanup:
    post:
      tags:
      - workspace-storage
      summary: Cleanup Orphans
      description: 'Delete every orphan file (blob + DB row) for this workspace.


        Owner-only — destructive and irreversible. Streams per-phase progress

        over the ``workspace:storage:cleanup_progress`` WebSocket event so the

        UI can render a progress bar.'
      operationId: cleanup_orphans_api_workspace_storage_orphans_cleanup_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CleanupResult'
  /api/workspace/storage/presign:
    post:
      tags:
      - workspace-storage
      summary: Presign Files
      description: 'Short-lived download URLs for files this workspace owns.


        Ownership is checked here, per file, against `workspace_id` — the URL itself

        is a bearer token for one object, so the boundary has to be enforced before

        it is minted, not after.'
      operationId: presign_files_api_workspace_storage_presign_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresignRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PresignedFile'
                type: array
                title: Response Presign Files Api Workspace Storage Presign Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/workspace/storage/info:
    get:
      tags:
      - workspace-storage
      summary: Storage Info
      description: 'What the workspace''s object storage looks like from outside.


        Deliberately honest about the credential story rather than implying an S3

        key is on its way.'
      operationId: storage_info_api_workspace_storage_info_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    OrphanSampleRow:
      properties:
        id:
          type: integer
          title: Id
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
        byte_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Byte Size
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        referenced_in:
          items:
            type: string
          type: array
          title: Referenced In
      type: object
      required:
      - id
      - filename
      - byte_size
      - created_at
      - referenced_in
      title: OrphanSampleRow
    CleanupResult:
      properties:
        deleted_files:
          type: integer
          title: Deleted Files
        deleted_blobs:
          type: integer
          title: Deleted Blobs
        total_bytes:
          type: integer
          title: Total Bytes
      type: object
      required:
      - deleted_files
      - deleted_blobs
      - total_bytes
      title: CleanupResult
    OrphanByMime:
      properties:
        mime_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Mime Type
        count:
          type: integer
          title: Count
        bytes:
          type: integer
          title: Bytes
      type: object
      required:
      - mime_type
      - count
      - bytes
      title: OrphanByMime
    PresignRequest:
      properties:
        file_ids:
          items:
            type: integer
          type: array
          maxItems: 200
          minItems: 1
          title: File Ids
        expires_in:
          type: integer
          maximum: 3600.0
          minimum: 60.0
          title: Expires In
          default: 900
      type: object
      required:
      - file_ids
      title: PresignRequest
    PresignedFile:
      properties:
        file_id:
          type: integer
          title: File Id
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        bucket:
          anyOf:
          - type: string
          - type: 'null'
          title: Bucket
        key:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
        mime_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Mime Type
        byte_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Byte Size
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - file_id
      - url
      - bucket
      - key
      - mime_type
      - byte_size
      title: PresignedFile
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrphanPreview:
      properties:
        files_count:
          type: integer
          title: Files Count
        total_bytes:
          type: integer
          title: Total Bytes
        by_mime:
          items:
            $ref: '#/components/schemas/OrphanByMime'
          type: array
          title: By Mime
        sample:
          items:
            $ref: '#/components/schemas/OrphanSampleRow'
          type: array
          title: Sample
      type: object
      required:
      - files_count
      - total_bytes
      - by_mime
      - sample
      title: OrphanPreview
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError