Popsink

Popsink probes API

The probes API from Popsink — 2 operation(s) for probes.

GitHub OpenAPI

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/popsink/refs/heads/main/openapi/popsink-probes-api-openapi.yml

OpenAPI Specification

popsink-probes-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Fast admin probes API
  version: 0.1.0
servers:
- url: /api
tags:
- name: probes
paths:
  /livez:
    get:
      tags:
      - probes
      summary: Probes:Livez
      description: Get the liveness probe.
      operationId: probes_livez_livez_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheck'
  /readyz:
    get:
      tags:
      - probes
      summary: Probes:Livez
      description: Get the readiness probe.
      operationId: probes_livez_readyz_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheck'
components:
  schemas:
    HealthCheck:
      properties:
        status:
          type: string
          title: Status
      type: object
      required:
      - status
      title: HealthCheck
      description: Healthcheck pydantic model.
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login