openapi.yaml

openapi: 3.0.0
info:
  title: Waygates API
  description: API for managing Caddy as a reverse proxy, redirect, and static file server.
  version: "1.0.0"
servers:
  - url: http://localhost:8080/api
    description: Local development server

components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: Admin User
        username:
          type: string
          example: admin
        email:
          type: string
          format: email
          example: admin@example.com
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time

    Proxy:
      type: object
      properties:
        id:
          type: integer
        type:
          type: string
          enum: [reverse_proxy, redirect, static]
        name:
          type: string
        hostname:
          type: string
        description:
          type: string
        ssl_enabled:
          type: boolean
        ssl_forced:
          type: boolean
        is_active:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        # Add type-specific fields later

    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object

  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

paths:
  /status:
    get:
      summary: Get Application Status
      tags: [Status]
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      caddy_status:
                        type: string
                        example: healthy
                      user_setup_complete:
                        type: boolean
                        example: true
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /auth/register:
    post:
      summary: Register a new user
      tags: [Authentication]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                username:
                  type: string
                email:
                  type: string
                password:
                  type: string
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /auth/login:
    post:
      summary: Login a user
      tags: [Authentication]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                identifier:
                  type: string
                password:
                  type: string
      responses:
        '200':
          description: Successful login
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                  refresh_token:
                    type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /auth/refresh:
    post:
      summary: Refresh access token
      tags: [Authentication]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                refresh_token:
                  type: string
      responses:
        '200':
          description: Tokens refreshed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      access_token:
                        type: string
                      refresh_token:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /auth/logout:
    post:
      summary: Logout user and revoke tokens
      tags: [Authentication]
      security:
        - BearerAuth: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                refresh_token:
                  type: string
                  description: Optional refresh token to revoke
      responses:
        '200':
          description: Successfully logged out
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /auth/me:
    get:
      summary: Get current user information
      tags: [Authentication]
      security:
        - BearerAuth: []
      responses:
        '200':
          description: Current user information
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      username:
                        type: string
                      email:
                        type: string
                      role:
                        type: string
                        nullable: true
                      permissions:
                        type: array
                        items:
                          type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /proxies:
    get:
      summary: List all proxies
      tags: [Proxies]
      security:
        - BearerAuth: []
      parameters:
        - in: query
          name: page
          schema:
            type: integer
        - in: query
          name: limit
          schema:
            type: integer
        - in: query
          name: search
          schema:
            type: string
      responses:
        '200':
          description: A list of proxies
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Proxy'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

    post:
      summary: Create a new proxy
      tags: [Proxies]
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Proxy'
      responses:
        '201':
          description: Proxy created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '409':
          description: Conflict

  /proxies/{id}:
    get:
      summary: Get a proxy by ID
      tags: [Proxies]
      security:
        - BearerAuth: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: A single proxy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '401':
          description: Unauthorized
        '404':
          description: Not Found

    put:
      summary: Update a proxy
      tags: [Proxies]
      security:
        - BearerAuth: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Proxy'
      responses:
        '200':
          description: Proxy updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '409':
          description: Conflict

    delete:
      summary: Delete a proxy
      tags: [Proxies]
      security:
        - BearerAuth: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Proxy deleted
        '401':
          description: Unauthorized
        '404':
          description: Not Found

  /proxies/{id}/enable:
    post:
      summary: Enable a proxy
      tags: [Proxies]
      security:
        - BearerAuth: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Proxy enabled
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found

  /proxies/{id}/disable:
    post:
      summary: Disable a proxy
      tags: [Proxies]
      security:
        - BearerAuth: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Proxy disabled
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found