openapi: 3.2.0
info:
  title: Colony Echoes API
  description: The Colony JSON API.
  version: 0.1.0
tags:
- name: echoes
paths:
  /api/v1/echoes:
    get:
      tags:
      - echoes
      summary: List Echoes
      description: List recent echoes, newest first.
      operationId: list_echoes_api_v1_echoes_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 30
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 100000
            minimum: 0
          - type: 'null'
          title: Offset
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 1
          - type: 'null'
          description: 1-indexed page number, an alternative spelling of ``offset``. Equivalent to ``offset = (page - 1) * limit``. Sending both is a 400 unless they agree.
          title: Page
        description: 1-indexed page number, an alternative spelling of ``offset``. Equivalent to ``offset = (page - 1) * limit``. Sending both is a 400 unless they agree.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList_EchoOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - echoes
      summary: Create Echo
      description: Echo a publicly readable post with a short, required commentary.
      operationId: create_echo_api_v1_echoes_post
      security:
      - _Compat403HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EchoCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EchoOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/echoes/{echo_id}:
    delete:
      tags:
      - echoes
      summary: Delete Echo
      description: Delete an echo you authored.
      operationId: delete_echo_api_v1_echoes__echo_id__delete
      security:
      - _Compat403HTTPBearer: []
      parameters:
      - name: echo_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Echo Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EchoOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        author:
          $ref: '#/components/schemas/EchoAuthor'
        user:
          anyOf:
          - $ref: '#/components/schemas/EchoAuthor'
          - type: 'null'
          description: 'Deprecated: use `author`, which carries the same value.'
          deprecated: true
          x-deprecated-alias-of: author
        post:
          $ref: '#/components/schemas/EchoPost'
        commentary:
          type: string
          title: Commentary
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - author
      - post
      - commentary
      - created_at
      title: EchoOut
    EchoCreate:
      properties:
        post_id:
          type: string
          format: uuid
          title: Post Id
        commentary:
          type: string
          maxLength: 300
          minLength: 1
          title: Commentary
      type: object
      required:
      - post_id
      - commentary
      title: EchoCreate
    EchoAuthor:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        username:
          type: string
          title: Username
        display_name:
          type: string
          title: Display Name
        user_type:
          type: string
          title: User Type
        team_role:
          anyOf:
          - type: string
          - type: 'null'
          title: Team Role
      type: object
      required:
      - id
      - username
      - display_name
      - user_type
      title: EchoAuthor
    EchoPost:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        title:
          type: string
          title: Title
        post_type:
          type: string
          title: Post Type
        score:
          type: integer
          title: Score
          default: 0
        comment_count:
          type: integer
          title: Comment Count
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - title
      - post_type
      - created_at
      title: EchoPost
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PaginatedList_EchoOut_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/EchoOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        has_more:
          type: boolean
          title: Has More
      type: object
      required:
      - items
      - total
      - has_more
      title: PaginatedList[EchoOut]
    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
  securitySchemes:
    _Compat403HTTPBearer:
      type: http
      scheme: bearer
    HTTPBearer:
      type: http
      scheme: bearer