> ## 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. # Obter o manifesto de eventos de streaming > Retorna o catálogo estático de eventos de negócio que o Reporter pode publicar sem divulgar a topologia do broker. ## OpenAPI ````yaml pt/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 é a documentação OpenAPI do Reporter. O binário unificado do Reporter serve a API REST (RUN_MODE=api) e/ou o worker de geração de relatórios do RabbitMQ (RUN_MODE=worker); RUN_MODE=all executa ambos em um único processo para desenvolvimento local. Todos os endpoints REST documentados aqui são servidos somente quando RUN_MODE=api ou all (porta :4005); o worker (porta :4006) expõe apenas health/readyz. license: name: Lerian Studio General License title: API do Midaz Reporter version: 4.0.0 servers: - url: http://localhost:4005 - url: https://localhost:4005 security: - BearerAuth: [] tags: - description: Instâncias de relatórios gerados e seu ciclo de vida. name: Reports - description: Definições reutilizáveis de relatórios. name: Templates - description: Construção interativa de templates de relatório. name: Template Builder - description: Acompanhamento de datas de vencimento de relatórios agendados. name: Deadlines - description: Entradas configuradas que fornecem dados para relatórios. name: Data Sources - description: Métricas agregadas de relatórios. name: Metrics - description: Catálogo de eventos de negócio publicados e políticas de entrega. name: Streaming paths: /v1/streaming/events: get: tags: - Streaming summary: Obter o manifesto de eventos de streaming description: >- Retorna o catálogo estático de eventos de negócio que o Reporter pode publicar sem divulgar a topologia do broker. operationId: getStreamingEvents responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingManifestHumaResponse' description: OK headers: Cache-Control: schema: description: >- Impede que intermediários e clientes armazenem a resposta do manifesto. examples: - no-store type: string '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Não autorizado '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Proibido '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Erro interno do servidor components: schemas: StreamingManifestHumaResponse: properties: events: description: Eventos de negócio que o Reporter pode 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: Metadados que identificam o publicador de eventos do Reporter. examples: - outboxSupported: true routePath: /v1/streaming/events serviceName: reporter sourceBase: //lerian.studio/reporter routes: description: >- Rotas de entrega sanitizadas quando a publicação da topologia está habilitada; o Reporter omite este campo. examples: - [] items: $ref: '#/components/schemas/StreamingRouteHumaResponse' type: - array - 'null' version: description: Versão semântica do formato de transmissão do manifesto. examples: - 1.0.0 type: string type: object Detail: properties: code: description: >- Código de erro de domínio estável e legível por máquina, no escopo do serviço emissor (formato: -NNNN). examples: - ERR-0001 type: string detail: description: Explicação legível específica para esta ocorrência do problema. examples: - Property foo is required but is missing. type: string errors: description: Lista opcional de detalhes individuais do erro 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: Referência URI que identifica a ocorrência específica do problema. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: Código de status HTTP examples: - 400 format: int64 type: integer title: description: >- Resumo curto e legível do tipo de problema. Esse valor não deve mudar entre ocorrências do erro. examples: - Bad Request type: string type: default: about:blank description: Referência URI para a documentação legível do erro. examples: - https://example.com/errors/example format: uri type: string type: object StreamingEventHumaResponse: properties: dataContentType: description: Tipo de mídia do payload de dados do evento. examples: - application/json type: string dataSchema: description: URI opcional que identifica o schema de dados do evento. examples: - https://schemas.lerian.studio/reporter/report-requested.json type: string defaultPolicy: $ref: '#/components/schemas/StreamingDeliveryPolicyHumaResponse' description: Política de entrega padrão deste evento. examples: - direct: direct dlq: on_routable_failure enabled: true outbox: fallback_on_circuit_open description: description: Finalidade legível do evento. examples: - A report generation request was accepted. type: string eventType: description: Ação de negócio no passado representada pelo evento. examples: - requested type: string key: description: Chave estável do catálogo para a definição do evento. examples: - report.requested type: string resourceType: description: Recurso de negócio representado pelo evento. examples: - report type: string schemaVersion: description: Versão do schema do payload do evento. examples: - 1.0.0 type: string systemEvent: description: >- Se o evento representa atividade do sistema em vez de uma ação de negócio iniciada pelo cliente. examples: - false type: boolean topic: description: Tópico lógico estável derivado da origem e da definição do evento. examples: - //lerian.studio/reporter/report/requested type: string type: object StreamingPublisherHumaResponse: properties: appVersion: description: Versão da aplicação Reporter. examples: - v4.0.0 type: string libVersion: description: Versão do manifesto da lib-streaming usada pelo Reporter. examples: - 1.0.0 type: string outboxSupported: description: Se o publicador aceita entrega por outbox transacional. examples: - true type: boolean producerId: description: >- Identificador opaco do processo quando fornecido por um produtor ativo. examples: - reporter-7f5d9c type: string routePath: description: Path HTTP autenticado que serve este manifesto. examples: - /v1/streaming/events type: string serviceName: description: Nome do serviço que publica os eventos. examples: - reporter type: string sourceBase: description: Prefixo estável de origem do CloudEvents. examples: - //lerian.studio/reporter type: string type: object StreamingRouteHumaResponse: properties: definitionKey: description: Chave da definição do evento servida pela rota. examples: - report.requested type: string destination: description: Destino de transporte sanitizado. examples: - reporter.events type: string dlqConfigured: description: Se a rota tem um destino de dead-letter. examples: - true type: boolean key: description: Chave estável da rota. examples: - reports-rabbitmq type: string required: description: Se uma falha na rota faz a emissão lógica falhar. examples: - true type: boolean target: description: Nome do destino lógico da entrega. examples: - primary type: string transport: description: Família do transporte de saída. enum: - kafka - sqs - rabbitmq - eventbridge - custom examples: - rabbitmq type: string type: object ErrorDetail: properties: location: description: >- Local em que o erro ocorreu, por exemplo, 'body.items[3].tags' ou 'path.thing-id' examples: - body.templateId type: string message: description: Texto da mensagem de erro examples: - expected string to match 'uuid' format type: string value: description: O valor no local informado examples: - not-a-uuid type: object StreamingDeliveryPolicyHumaResponse: properties: direct: description: Modo de publicação direta. enum: - direct - skip examples: - direct type: string dlq: description: Modo de tratamento de dead-letter. enum: - never - on_routable_failure examples: - on_routable_failure type: string enabled: description: Se a entrega está habilitada para o evento. examples: - true type: boolean outbox: description: Modo de publicação por outbox transacional. enum: - never - fallback_on_circuit_open - always examples: - fallback_on_circuit_open type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: Token bearer JWT emitido pelo provedor de identidade. scheme: bearer type: http ````