Resourcly health API

The health API from Resourcly — 3 operation(s) for health.

OpenAPI Specification

resourcly-health-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: API for document processing, item similarity search, and analytics.
  title: Resourcly analytics health API
  termsOfService: https://resourcly.com/terms
  contact:
    name: API Support
    email: support@resourcly.com
  license:
    name: Proprietary
  version: 1.0.0
host: api.resourcly.com
basePath: /v1
tags:
- name: health
paths:
  /health:
    get:
      description: Returns OK if the service is alive
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - health
      summary: Liveness probe
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/handlers.HealthResponse'
  /ready:
    get:
      description: Returns service readiness status including database connectivity
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - health
      summary: Readiness probe
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/handlers.ReadyResponse'
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/handlers.ReadyResponse'
  /ready/detailed:
    get:
      description: Returns service readiness status including database pool statistics for observability
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - health
      summary: Detailed readiness probe with pool stats
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/handlers.DetailedReadyResponse'
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/handlers.DetailedReadyResponse'
definitions:
  handlers.DetailedReadyResponse:
    type: object
    properties:
      pool_stats:
        $ref: '#/definitions/handlers.PoolStats'
      services:
        type: object
        additionalProperties:
          type: string
      status:
        type: string
  handlers.HealthResponse:
    type: object
    properties:
      status:
        type: string
      version:
        type: string
  handlers.ReadyResponse:
    type: object
    properties:
      services:
        type: object
        additionalProperties:
          type: string
      status:
        type: string
  handlers.PoolStats:
    type: object
    properties:
      acquired_conns:
        type: integer
      backpressure:
        description: '"normal", "warning", "active"'
        type: string
      idle_conns:
        type: integer
      max_conns:
        type: integer
      total_conns:
        type: integer
      usage_percent:
        type: number
securityDefinitions:
  BearerAuth:
    description: 'Firebase JWT token. Format: "Bearer {token}"'
    type: apiKey
    name: Authorization
    in: header