openapi.yaml

openapi: 3.0.0
info:
  title: Whack
  version: '1.0'
servers:
  - url: 'https://whack.chat/api'
paths:
  '/channels/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    get:
      summary: Show Channel
      tags:
        - channels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      operationId: channels.show
      security:
        - BearerAuth: []
    put:
      summary: Update Channel
      tags:
        - channels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
      operationId: channels.update
      security:
        - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Channel'
    delete:
      summary: Archive Channel
      tags:
        - channels
      responses:
        '200':
          description: OK
      operationId: channels.archive
      security:
        - BearerAuth: []
  /channels:
    get:
      summary: List all channels
      tags:
        - channels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Channel'
      operationId: channels.index
      description: ''
      security:
        - BearerAuth: []
      parameters:
        - schema:
            type: object
          in: query
          name: order
        - schema:
            type: object
          in: query
          name: filter
    post:
      summary: Create a new channel
      tags:
        - channels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
      operationId: channels.create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Channel'
      security: []
      description: ''
  /login:
    post:
      summary: Authenticate to get a Paseto token
      tags:
        - authentication
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                required:
                  - token
      operationId: auth.login
      security:
        - BasicAuth: []
      parameters: []
  '/channels/{id}/join':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    post:
      summary: Join a Channel
      tags:
        - channels
      responses:
        '200':
          description: OK
      operationId: channels.join
      security:
        - BearerAuth: []
  '/channels/{id}/leave':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    post:
      summary: Leave a Channel
      tags:
        - channels
      responses:
        '200':
          description: OK
      operationId: channels.leave
      security:
        - BearerAuth: []
      description: ''
  /me:
    get:
      summary: Get information about the current User
      tags:
        - me
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  username:
                    type: string
      operationId: me.show
      security:
        - BearerAuth: []
  /me/channels:
    get:
      summary: List of Channels the current User is a Member of
      tags:
        - me
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Channel'
      operationId: me.channels
      security:
        - BearerAuth: []
      parameters:
        - schema:
            type: object
          in: query
          name: order
    parameters: []
  /messages:
    post:
      summary: Create a Message
      tags:
        - messages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
      operationId: messages.create
      security:
        - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
    get:
      summary: List all Messages
      tags:
        - messages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Message'
      operationId: messages.index
      security:
        - BearerAuth: []
      parameters:
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: order
        - schema:
            type: object
          in: query
          name: filter
      description: ''
  '/messages/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    delete:
      summary: Delete a Message
      tags:
        - messages
      responses:
        '200':
          description: OK
      operationId: messages.delete
      security:
        - BearerAuth: []
    put:
      summary: Update a Message
      tags:
        - messages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
      operationId: messages.update
      security:
        - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
    get:
      summary: Show an Individual Message
      operationId: messages.show
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
      security:
        - BearerAuth: []
  /openapi.yaml:
    get:
      summary: Your GET endpoint
      tags: []
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
      operationId: api.specification
      security: []
components:
  schemas:
    Channel:
      title: Channel
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        meta:
          type: object
          required:
            - members
          properties:
            members:
              type: number
              readOnly: true
          readOnly: true
      required:
        - name
        - meta
    Message:
      title: Message
      type: object
      properties:
        id:
          type: string
          readOnly: true
        author:
          type: object
          required:
            - username
          properties:
            username:
              type: string
              readOnly: true
          readOnly: true
        channel:
          type: string
        body:
          type: string
        created_at:
          type: string
          readOnly: true
        updated_at:
          type: string
          readOnly: true
      required:
        - id
        - author
        - channel
        - body
        - created_at
        - updated_at
      description: ''
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    BearerAuth:
      name: token
      type: apiKey
      in: cookie