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

# Obtener el manifiesto de eventos de streaming

> Devuelve el catálogo de eventos de negocio en pasado que publica este servicio, con la política de entrega de cada evento. Es un descriptor de contrato estático que no revela la topología del broker.



## OpenAPI

````yaml es/openapi/v3-current/reporter.yaml get /v1/streaming/events
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    Esta es la documentación OpenAPI de Reporter. El binario unificado de
    Reporter ejecuta la API REST (RUN_MODE=api), el worker de generación de
    informes de RabbitMQ (RUN_MODE=worker) o ambos; RUN_MODE=all ejecuta los dos
    en un único proceso para el desarrollo local. Todos los endpoints REST
    documentados aquí solo están disponibles cuando RUN_MODE=api o RUN_MODE=all
    (puerto :4005); el worker (puerto :4006) expone únicamente los endpoints de
    health y readyz.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Instancias de informes generados y su ciclo de vida.
    name: Informes
  - description: Definiciones de informes reutilizables.
    name: Plantillas
  - description: Creación interactiva de plantillas de informes.
    name: Constructor de plantillas
  - description: Seguimiento de las fechas de vencimiento de informes programados.
    name: Plazos
  - description: Entradas configuradas que proporcionan datos a los informes.
    name: Fuentes de datos
  - description: Métricas agregadas de informes.
    name: Métricas
  - description: Catálogo publicado de eventos de negocio y políticas de entrega.
    name: Streaming
paths:
  /v1/streaming/events:
    get:
      tags:
        - Streaming
      summary: Obtener el manifiesto de eventos de streaming
      description: >-
        Devuelve el catálogo de eventos de negocio en pasado que publica este
        servicio, con la política de entrega de cada evento. Es un descriptor de
        contrato estático que no revela la topología del broker.
      operationId: getStreamingEvents
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingManifestHumaResponse'
          description: Correcto
          headers:
            Cache-Control:
              schema:
                description: >-
                  Impide que los intermediarios y los clientes almacenen la
                  respuesta del manifiesto.
                examples:
                  - no-store
                type: string
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: No autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Prohibido
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error interno del servidor
components:
  schemas:
    StreamingManifestHumaResponse:
      properties:
        events:
          description: Eventos de negocio que Reporter puede publicar.
          examples:
            - - dataContentType: application/json
                defaultPolicy:
                  direct: direct
                  dlq: on_routable_failure
                  enabled: true
                  outbox: fallback_on_circuit_open
                eventType: requested
                key: report.requested
                resourceType: report
                schemaVersion: 1.0.0
                systemEvent: false
                topic: //lerian.studio/reporter/report/requested
          items:
            $ref: '#/components/schemas/StreamingEventHumaResponse'
          type:
            - array
            - 'null'
        publisher:
          $ref: '#/components/schemas/StreamingPublisherHumaResponse'
          description: Metadatos que identifican al publicador de eventos de Reporter.
          examples:
            - outboxSupported: true
              routePath: /v1/streaming/events
              serviceName: reporter
              sourceBase: //lerian.studio/reporter
        routes:
          description: >-
            Rutas de entrega depuradas cuando está habilitada la publicación de
            topología; Reporter omite este campo.
          examples:
            - []
          items:
            $ref: '#/components/schemas/StreamingRouteHumaResponse'
          type:
            - array
            - 'null'
        version:
          description: Versión semántica del formato de transmisión del manifiesto.
          examples:
            - 1.0.0
          type: string
      type: object
    Detail:
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, limitado
            al servicio emisor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicación legible específica de esta instancia del problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalles individuales del error
          examples:
            - - location: body.templateId
                message: expected string to match 'uuid' format
                value: not-a-uuid
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: Referencia URI que identifica la instancia específica del problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumen breve y legible del tipo de problema. Este valor no debe
            cambiar entre instancias del error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: Referencia URI a la documentación legible del error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    StreamingEventHumaResponse:
      properties:
        dataContentType:
          description: Tipo de medio del payload de datos del evento.
          examples:
            - application/json
          type: string
        dataSchema:
          description: URI opcional que identifica el esquema de datos del evento.
          examples:
            - https://schemas.lerian.studio/reporter/report-requested.json
          type: string
        defaultPolicy:
          $ref: '#/components/schemas/StreamingDeliveryPolicyHumaResponse'
          description: Política de entrega predeterminada para este evento.
          examples:
            - direct: direct
              dlq: on_routable_failure
              enabled: true
              outbox: fallback_on_circuit_open
        description:
          description: Propósito legible del evento.
          examples:
            - A report generation request was accepted.
          type: string
        eventType:
          description: Acción de negocio en pasado representada por el evento.
          examples:
            - requested
          type: string
        key:
          description: Clave estable del catálogo para la definición del evento.
          examples:
            - report.requested
          type: string
        resourceType:
          description: Recurso de negocio representado por el evento.
          examples:
            - report
          type: string
        schemaVersion:
          description: Versión del esquema del payload del evento.
          examples:
            - 1.0.0
          type: string
        systemEvent:
          description: >-
            Indica si el evento representa actividad del sistema en lugar de una
            acción de negocio iniciada por el cliente.
          examples:
            - false
          type: boolean
        topic:
          description: >-
            Tema lógico estable derivado del origen y de la definición del
            evento.
          examples:
            - //lerian.studio/reporter/report/requested
          type: string
      type: object
    StreamingPublisherHumaResponse:
      properties:
        appVersion:
          description: Versión de la aplicación Reporter.
          examples:
            - v4.0.0
          type: string
        libVersion:
          description: Versión del manifiesto de lib-streaming usada por Reporter.
          examples:
            - 1.0.0
          type: string
        outboxSupported:
          description: >-
            Indica si el publicador admite la entrega mediante outbox
            transaccional.
          examples:
            - true
          type: boolean
        producerId:
          description: >-
            Identificador opaco del proceso cuando un productor activo lo
            proporciona.
          examples:
            - reporter-7f5d9c
          type: string
        routePath:
          description: Ruta HTTP autenticada que sirve este manifiesto.
          examples:
            - /v1/streaming/events
          type: string
        serviceName:
          description: Nombre del servicio que publica los eventos.
          examples:
            - reporter
          type: string
        sourceBase:
          description: Prefijo estable del origen de CloudEvents.
          examples:
            - //lerian.studio/reporter
          type: string
      type: object
    StreamingRouteHumaResponse:
      properties:
        definitionKey:
          description: Clave de definición del evento servido por la ruta.
          examples:
            - report.requested
          type: string
        destination:
          description: Destino de transporte depurado.
          examples:
            - reporter.events
          type: string
        dlqConfigured:
          description: Indica si la ruta tiene un destino de mensajes no entregados.
          examples:
            - true
          type: boolean
        key:
          description: Clave estable de la ruta.
          examples:
            - reports-rabbitmq
          type: string
        required:
          description: Indica si un fallo de la ruta provoca que falle la emisión lógica.
          examples:
            - true
          type: boolean
        target:
          description: Nombre del destino lógico de entrega.
          examples:
            - primary
          type: string
        transport:
          description: Familia de transporte de salida.
          enum:
            - kafka
            - sqs
            - rabbitmq
            - eventbridge
            - custom
          examples:
            - rabbitmq
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Lugar donde ocurrió el error, por ejemplo, 'body.items[3].tags' o
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Texto del mensaje de error
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: Valor en la ubicación indicada
          examples:
            - not-a-uuid
      type: object
    StreamingDeliveryPolicyHumaResponse:
      properties:
        direct:
          description: Modo de publicación directa.
          enum:
            - direct
            - skip
          examples:
            - direct
          type: string
        dlq:
          description: Modo de gestión de mensajes no entregados.
          enum:
            - never
            - on_routable_failure
          examples:
            - on_routable_failure
          type: string
        enabled:
          description: Indica si la entrega está habilitada para el evento.
          examples:
            - true
          type: boolean
        outbox:
          description: Modo de publicación mediante outbox transaccional.
          enum:
            - never
            - fallback_on_circuit_open
            - always
          examples:
            - fallback_on_circuit_open
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'.
        Solo es obligatoria cuando el plugin de autenticación está habilitado.
      scheme: bearer
      type: http

````