invoicepdfs-com Health API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Health API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged health across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Health
paths:
  /health:
    get:
      tags:
      - Health
      summary: Get Health
      description: 'Is the API process alive.


        Answers as long as the process can serve a request; it checks nothing

        behind it. For whether the service can actually do work, use

        `get_readiness`.'
      operationId: get_health
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      x-visibility: public
  /version:
    get:
      tags:
      - Health
      summary: Get Version
      description: Which build is deployed.
      operationId: get_version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
      x-visibility: public
  /ready:
    get:
      tags:
      - Health
      summary: Get Readiness
      description: 'Can the API serve real traffic — dependencies included.


        Checks the database, storage, and the separate render service, and reports

        each one. `status` is `ready` only when all three are `ok`, so this is the

        check to point a load balancer at. `get_health` answers sooner but proves

        less.'
      operationId: get_readiness
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
      x-visibility: public
components:
  schemas:
    VersionResponse:
      properties:
        version:
          type: string
          title: Version
      type: object
      required:
      - version
      title: VersionResponse
    ReadyResponse:
      properties:
        status:
          type: string
          enum:
          - ready
          - not_ready
          title: Status
        dependencies:
          additionalProperties:
            type: string
            enum:
            - ok
            - error
          type: object
          title: Dependencies
        workers:
          additionalProperties:
            type: string
          type: object
          title: Workers
        degraded:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Degraded
      type: object
      required:
      - status
      - dependencies
      title: ReadyResponse
    HealthResponse:
      properties:
        status:
          type: string
          const: ok
          title: Status
        service:
          type: string
          title: Service
        version:
          type: string
          title: Version
      type: object
      required:
      - status
      - service
      - version
      title: HealthResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs