> ## 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.

# Listar o catálogo de eventos

> Retorna o snapshot do catálogo alimentado por manifesto — a agregação last-known-good dos manifestos de produtor que o Streaming Hub acompanha. O catálogo é global na v1 (byte-idêntico independentemente de qual tenant se autentica) e existe apenas no plano de controle; o plano de dados nunca o consulta. Um snapshot vazio retorna `200` com `events: []` (fail-closed para o last-known-good — nunca um erro em um catálogo vazio).



## OpenAPI

````yaml pt/openapi/v3-current/streaming-hub.yaml get /v1/catalog
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:
  /v1/catalog:
    get:
      tags:
        - Catalog
      summary: Listar o catálogo de eventos
      description: >-
        Retorna o snapshot do catálogo alimentado por manifesto — a agregação
        last-known-good dos manifestos de produtor que o Streaming Hub
        acompanha. O catálogo é global na v1 (byte-idêntico independentemente de
        qual tenant se autentica) e existe apenas no plano de controle; o plano
        de dados nunca o consulta. Um snapshot vazio retorna `200` com `events:
        []` (fail-closed para o last-known-good — nunca um erro em um catálogo
        vazio).
      operationId: getCatalog
      responses:
        '200':
          description: O snapshot do catálogo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth: []
components:
  schemas:
    CatalogResponse:
      type: object
      additionalProperties: false
      properties:
        events:
          type: array
          description: >-
            The catalog entries in deterministic (topic, schemaMajor, eventType)
            order. Empty when the snapshot is empty.
          items:
            $ref: '#/components/schemas/CatalogEvent'
        availableMajors:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
          description: >-
            Per topic, the set of distinct schema-major values present in the
            snapshot, each ascending. An empty object when the snapshot is
            empty.
          examples:
            - lerian.streaming.transaction.created:
                - 1
      required:
        - events
        - availableMajors
    CatalogEvent:
      type: object
      additionalProperties: false
      properties:
        eventType:
          type: string
          description: The event type (the `<resource>.<event>` tail).
          examples:
            - transaction.created
        topic:
          type: string
          description: The Kafka topic the event is published on.
          examples:
            - lerian.streaming.transaction.created
        schemaVersion:
          type: string
          description: The full schema version.
          examples:
            - 1.0.0
        schemaMajor:
          type: integer
          description: The schema major.
          examples:
            - 1
        dataSchema:
          type: string
          description: >-
            An opaque schema URL passthrough. Omitted when empty; Streaming Hub
            never resolves or fetches it.
          examples:
            - https://schemas.example.com/transaction/created/1.json
        description:
          type: string
          description: A human-readable description of the event.
          examples:
            - A transaction was created.
      required:
        - eventType
        - topic
        - schemaVersion
        - schemaMajor
        - description
    Error:
      type: object
      additionalProperties: false
      description: >-
        The flat error envelope used across the `/v1` and `/admin` surfaces. It
        carries a single low-cardinality, machine-readable token and never leaks
        secret material or internal detail. (A `403` from the authorization
        decision point is the one exception — its body is plain text.)
      properties:
        error:
          type: string
          description: The machine-readable error token.
          examples:
            - not_found
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        A autenticação falhou, ou não há contexto de tenant confiável. `error` é
        `unauthorized` (corpo uniforme — nenhuma razão é revelada).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        O ponto de decisão de autorização (authorization decision point) negou a
        requisição. O corpo é texto puro (não o envelope de erro JSON).
      content:
        text/plain:
          schema:
            type: string
    InternalError:
      description: >-
        Uma falha de infraestrutura. `error` é `internal_error` (sanitizado; o
        detalhe é logado, nunca retornado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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.

````