management-openapi.yml

openapi: 3.0.0
info:
  title: Management API
  version: 1.0.0
  description: API for managing capsules

servers:
  - url: https://management.sid.ai/api/v1

paths:
  /capsules:
    post:
      summary: Create a new capsule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the capsule. Doesn't have to be unique. 
              required:
                - name
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique ID of the capsule. Use this ID to make requests to the API. It should look something like `irrotational-airfoil`.
                  message:
                    type: string
                    description: A nice message from the server.
                required:
                  - id
                  - message
        '400':
          description: Bad request
        '500':
          description: Internal server error
  /capsules/{id}:
    delete:
      summary: Delete a capsule
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the capsule to delete. It should look something like `irrotational-airfoil`.
          schema:
            type: string
      responses:
        '204':
          description: Successful deletion (no content)
        '400':
          description: Bad request
        '404':
          description: Capsule not found
        '500':
          description: Internal server error

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer authentication header of the form Bearer `<API_KEY>`. API keys can be generated in the [dashboard](https://dashboard.sid.ai/).

security:
  - bearerAuth: []