ASAP Files API

openapi: 3.2.0
info:
  title: ASAP Platform Files API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: Files
  description: 'Media library: files and folders, tenant-scoped.'
paths:
  /v1/files:
    get:
      tags:
      - Files
      summary: GET /v1/files
      operationId: listFiles
      parameters:
      - name: folder_id
        in: query
        description: Folder id, or `root` for the library root. Omit for every file.
        required: false
        schema:
          type: string
      - name: after
        in: query
        description: Cursor from a previous page.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Page size, clamped to 1..=100.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: A page of files.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileListView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:read
      - session: []
    post:
      tags:
      - Files
      summary: POST /v1/files
      operationId: uploadFile
      requestBody:
        description: multipart/form-data with a `file` part.
        content:
          multipart/form-data:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: Identical content already stored; the existing file is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileView'
        '201':
          description: File stored.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: Body exceeds the upload limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Rejected by upload validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Storage quota exhausted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:write
      - session: []
  /v1/files/{id}:
    get:
      tags:
      - Files
      summary: GET /v1/files/{id}
      operationId: getFile
      parameters:
      - name: id
        in: path
        description: File id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: No such file in this org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:read
      - session: []
    delete:
      tags:
      - Files
      summary: DELETE /v1/files/{id}
      operationId: deleteFile
      parameters:
      - name: id
        in: path
        description: File id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: File deleted.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: No such file in this org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:write
      - session: []
    patch:
      tags:
      - Files
      summary: PATCH /v1/files/{id}
      operationId: updateFile
      parameters:
      - name: id
        in: path
        description: File id.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFileRequest'
        required: true
      responses:
        '200':
          description: The updated file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: No such file in this org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid field value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:write
      - session: []
  /v1/files/{id}/content:
    get:
      tags:
      - Files
      summary: GET /v1/files/{id}/content
      operationId: downloadFile
      parameters:
      - name: id
        in: path
        description: File id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The file bytes, when the backend cannot presign.
        '302':
          description: Redirect to a short-lived presigned URL.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: No such file in this org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:read
      - session: []
  /v1/folders:
    get:
      tags:
      - Files
      summary: GET /v1/folders
      operationId: listFolders
      parameters:
      - name: parent_id
        in: query
        description: Parent folder; omit for the root.
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Direct children, by name.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FolderView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:read
      - session: []
    post:
      tags:
      - Files
      summary: POST /v1/folders
      operationId: createFolder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderRequest'
        required: true
      responses:
        '201':
          description: Folder created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: A sibling already has that name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Empty name, or the depth ceiling was reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:write
      - session: []
  /v1/folders/{id}:
    delete:
      tags:
      - Files
      summary: DELETE /v1/folders/{id}
      operationId: deleteFolder
      parameters:
      - name: id
        in: path
        description: Folder id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Folder deleted; its files moved to the root.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing files:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: No such folder in this org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - files:write
      - session: []
components:
  schemas:
    CreateFolderRequest:
      type: object
      description: Body accepted by the folder-creation endpoint.
      required:
      - name
      properties:
        name:
          type: string
          description: Display name.
        parent_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Parent folder; omit to create at the root.
    FileListView:
      type: object
      description: A page of files.
      required:
      - files
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/FileView'
          description: Rows, newest first.
        next_cursor:
          type:
          - string
          - 'null'
          description: Cursor to pass as `after` for the next page, or `null` at the end.
    UpdateFileRequest:
      type: object
      description: 'Body accepted by the update endpoint.


        Absent fields are left untouched. `folder_id` and `description` accept an

        explicit `null` to clear them — `Patch` is what carries that third state

        without an `Option<Option<T>>`.'
      properties:
        description:
          type:
          - string
          - 'null'
          description: '`null` clears the caption; absent leaves it alone.'
        filename:
          type:
          - string
          - 'null'
          description: New name.
        folder_id:
          type:
          - string
          - 'null'
          format: uuid
          description: '`null` moves the file to the root; absent leaves it in place.'
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Replacement tag set.
        visibility:
          type:
          - string
          - 'null'
          description: '`private` or `link`.'
    FileView:
      type: object
      description: Public projection of a stored file.
      required:
      - id
      - filename
      - byte_size
      - content_type
      - sha256
      - visibility
      - tags
      - created_at
      - updated_at
      properties:
        byte_size:
          type: integer
          format: int64
          description: Stored size in bytes.
        content_type:
          type: string
          description: 'Media type of the stored bytes — the converted one when the upload was

            transcoded, which may differ from what was sent.'
        created_at:
          type: string
          description: RFC 3339 creation timestamp.
        description:
          type:
          - string
          - 'null'
          description: Optional caption.
        filename:
          type: string
          description: Stored file name.
        folder_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Containing folder, or `null` at the library root.
        id:
          type: string
          format: uuid
          description: File id.
        sha256:
          type: string
          description: Lowercase-hex SHA-256 of the bytes as uploaded (deduplication key).
        tags:
          type: array
          items:
            type: string
          description: Free-form labels.
        updated_at:
          type: string
          description: RFC 3339 last-modification timestamp.
        visibility:
          type: string
          description: '`private` or `link`.'
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    FolderView:
      type: object
      description: Public projection of a folder.
      required:
      - id
      - name
      - path
      - created_at
      properties:
        color:
          type:
          - string
          - 'null'
          description: Optional `#rrggbb` accent.
        created_at:
          type: string
          description: RFC 3339 creation timestamp.
        icon:
          type:
          - string
          - 'null'
          description: Optional icon slug.
        id:
          type: string
          format: uuid
          description: Folder id.
        name:
          type: string
          description: Display name.
        parent_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Parent folder, or `null` at the root.
        path:
          type: string
          description: Materialized path, for breadcrumbs.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session