> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Sondagem de readiness

> Consolida todo o conjunto de sondagens (boot gates, alcançabilidade do Postgres, liveness do consumidor e os degradadores) em um único veredito de readiness. `Healthy` e `Degraded` retornam `200` (mantidos em rotação); `Down` retorna `503`. Conecte-a a uma readiness probe do Kubernetes. Não exige autenticação.



## OpenAPI

````yaml pt/openapi/v3-current/streaming-hub.yaml get /readyz
openapi: 3.1.0
info:
  title: Lerian Streaming Hub API
  version: v1.0.0
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  license:
    name: Lerian Studio General License
  description: >-
    A API do plano de controle do Streaming Hub. O Streaming Hub é a borda
    gerenciada de entrega de eventos da Lerian: ele consome CloudEvents do
    backbone de streaming interno da plataforma e faz o fan-out para os destinos
    externos do próprio tenant — webhooks, Amazon SQS, RabbitMQ, Amazon
    EventBridge ou uma caixa de entrada pull. Esta API permite que um tenant
    navegue pelo catálogo de eventos alimentado por manifesto, crie e gerencie
    assinaturas de entrega, verifique e rotacione suas credenciais, consulte a
    saúde da entrega e puxe (pull) os eventos aos quais tem direito.


    Os erros usam um envelope plano `{"error":"<token>"}` (um token de baixa
    cardinalidade, legível por máquina — nunca problem+json do RFC 9457). As
    operações de mutação exigem um cabeçalho `X-Idempotency` para semântica de
    no-máximo-uma-vez (at-most-once); uma requisição repetida (replay) retorna a
    resposta original byte a byte com `X-Idempotency-Replayed: true`. O catálogo
    e a superfície de eventos por pull têm escopo de tenant através do JWT
    bearer; os endpoints operacionais de sondagem (`/healthz`, `/readyz`,
    `/version`, `/runtime`, `/metrics`) não exigem autenticação. O Streaming Hub
    é closed source sob a Lerian Studio General License.
servers:
  - url: https://streaming-hub.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: Catalog
    description: >-
      Navegue pelo catálogo de tipos de evento disponíveis para assinatura,
      alimentado por manifesto.
  - name: Subscriptions
    description: >-
      Crie, leia, atualize e exclua assinaturas de entrega e conduza o ciclo de
      vida de verificação do destino (ping, verify, credential, delegated grant,
      rotação de segredo, saúde).
  - name: Event Delivery
    description: >-
      Puxe (pull) os eventos aos quais uma assinatura de sink pull tem direito
      (leitura com cursor-como-confirmação).
  - name: Admin
    description: >-
      Análise forense de operador entre tenants (cross-tenant). Exige um escopo
      de autorização de operador.
  - name: Operational
    description: >-
      Sondagens não autenticadas de liveness, readiness, build, runtime e
      métricas.
paths:
  /readyz:
    get:
      tags:
        - Operational
      summary: Sondagem de readiness
      description: >-
        Consolida todo o conjunto de sondagens (boot gates, alcançabilidade do
        Postgres, liveness do consumidor e os degradadores) em um único veredito
        de readiness. `Healthy` e `Degraded` retornam `200` (mantidos em
        rotação); `Down` retorna `503`. Conecte-a a uma readiness probe do
        Kubernetes. Não exige autenticação.
      operationId: getReadiness
      responses:
        '200':
          description: A réplica está pronta (estado `healthy` ou `degraded`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
        '503':
          description: A réplica não está pronta (estado `down`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
      security: []
components:
  schemas:
    ReadinessResponse:
      type: object
      description: The readiness verdict and its per-probe detail.
      properties:
        state:
          type: string
          description: >-
            The folded readiness state. `healthy` / `degraded` return `200`;
            `down` returns `503`.
          enum:
            - healthy
            - degraded
            - down
          examples:
            - healthy
      required:
        - state
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Um JWT bearer emitido pelo plugin-auth (lib-auth). A identidade do
        tenant é resolvida a partir das claims validadas do token; a superfície
        `/v1` nunca lê um tenant do corpo, do path ou da query. Chamadores de
        máquina obtêm um token via o fluxo client-credentials do plugin-auth. A
        superfície `/admin` autoriza contra um escopo de operador e não carrega
        contexto de tenant.

````