components:
  schemas:
    checkapp.Info:
      properties:
        host:
          type: string
        status:
          type: string
        version:
          type: string
      type: object
    checkapp.Ready:
      properties:
        status:
          example: OK
          type: string
      type: object
    errs.Error:
      properties:
        code:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/errs.FieldError'
          type: array
          uniqueItems: false
        message:
          type: string
      type: object
    errs.FieldError:
      properties:
        error:
          type: string
        name:
          type: string
      type: object
externalDocs:
  description: Stonebranch Documentation
  url: https://docs.stonebranch.com
info:
  description: UDMG Secure Proxy Server handles incoming connections.
  title: UDMG Secure Proxy Server API
  version: '3.4.0'
openapi: 3.1.0
paths:
  /v1/liveness:
    get:
      description: Returns simple status info if the service is alive.
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkapp.Info'
          description: OK
      summary: Returns simple status info if the service is alive.
      tags:
      - healthcheck
  /v1/metrics:
    get:
      description: Retrieve prometheus metrics.
      responses:
        "200":
          content:
            application/json:
              schema:
                type: object
          description: OK
      summary: Retrieve prometheus metrics.
      tags:
      - metrics
  /v1/readiness:
    get:
      description: Checks if the database is ready.
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkapp.Ready'
          description: OK
        "503":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errs.Error'
          description: Service Unavailable
      summary: Checks if the database is ready.
      tags:
      - healthcheck