Pular para conteúdo

OpenAPI Doc — projeções e Inbox

Owner: OpenAPI Doc. Escopo: database do tenant via biblioteca Mongo. São dados derivados de Core/Template Service; não são as configurações originais de autoria.

Modelos visuais

Projeção OpenAPI e Inbox

O handler atualiza a projeção e depois registra o evento. Não há FK entre as collections.

Projeção OpenAPI e Inbox; visão simplificada. Detalhes no visualizador abaixo. Projeção OpenAPI e Inbox; visão simplificada em tema escuro.

Explorar diagramas detalhados com zoom

Legenda e convenções dos modelos. Os dicionários e evidências desta página permanecem a referência dos campos.

%%{init: {"theme":"base","themeVariables":{"fontFamily":"Arial, sans-serif","fontSize":"16px","lineColor":"#64748b","primaryTextColor":"#172b4d"},"flowchart":{"htmlLabels":true,"useMaxWidth":true,"nodeSpacing":28,"rankSpacing":38,"padding":14,"curve":"linear","subGraphTitleMargin":{"top":12,"bottom":16}},"sequence":{"useMaxWidth":true,"actorMargin":28,"width":145,"height":45,"diagramMarginX":32,"diagramMarginY":12,"messageMargin":24,"wrap":true,"mirrorActors":false},"themeCSS":".edgeLabel, .edgeLabel p {background-color:var(--diagram-surface)!important;color:var(--diagram-text)!important}\n.cluster rect {fill:var(--diagram-group)!important;stroke:var(--diagram-line)!important}\n.cluster-label span, .cluster-label text {color:var(--diagram-text)!important;fill:var(--diagram-text)!important}\n.flowchart-link, .actor-line {stroke:var(--diagram-line)!important}\nmarker path {fill:var(--diagram-line)!important;stroke:var(--diagram-line)!important}\n.actor {fill:var(--diagram-domain)!important;stroke:var(--diagram-domain-border)!important}\ntext.actor, .messageText, .loopText, .labelText {fill:var(--diagram-text)!important}\n.messageLine0, .messageLine1, .loopLine {stroke:var(--diagram-line)!important}\n.labelBox {fill:var(--diagram-surface)!important;stroke:var(--diagram-line)!important}\n.note {fill:var(--diagram-async)!important;stroke:var(--diagram-async-border)!important}\n.noteText {fill:var(--diagram-text)!important}\n.nodeLabel, .nodeLabel p, .nodeLabel span {color:var(--diagram-text)!important}\n.node .nodeLabel, .node .nodeLabel p {font-size:17px;font-weight:600;line-height:1.4;text-align:center}\n.nodeLabel small {display:inline-block;margin-top:4px;font-size:15px;font-weight:400;line-height:1.4;color:var(--diagram-description)!important}\ntext.actor, text.actor tspan {font-size:17px;font-weight:600}\n.node.entry rect, .node.entry polygon, .node.entry path, .node.entry circle {fill:var(--diagram-entry)!important;stroke:var(--diagram-entry-border)!important}\n.node.domain rect, .node.domain polygon, .node.domain path, .node.domain circle {fill:var(--diagram-domain)!important;stroke:var(--diagram-domain-border)!important}\n.node.security rect, .node.security polygon, .node.security path, .node.security circle {fill:var(--diagram-security)!important;stroke:var(--diagram-security-border)!important}\n.node.store rect, .node.store polygon, .node.store path, .node.store circle {fill:var(--diagram-store)!important;stroke:var(--diagram-store-border)!important}\n.node.async rect, .node.async polygon, .node.async path, .node.async circle {fill:var(--diagram-async)!important;stroke:var(--diagram-async-border)!important}\n.node.external rect, .node.external polygon, .node.external path, .node.external circle {fill:var(--diagram-external)!important;stroke:var(--diagram-external-border)!important}\n text.actor tspan, .loopText tspan, .labelText tspan, .messageText tspan, .noteText tspan {fill:var(--diagram-text)!important}\n\n"}}%%
flowchart TB
    source["Core / Template Service<br/><small>Configurações publicadas</small>"]:::domain
    doc["gateway_openapi<br/><small>Projeção OpenAPI em string JSON</small>"]:::store
    inbox["inbox_processed<br/><small>Registro de evento processado</small>"]:::store
    consumer["EventHandler<br/><small>Processamento no OpenAPI Doc</small>"]:::async
    consumer -->|Consulta por HTTP| source
    consumer -->|Gera / exclui| doc
    consumer -->|Após processar| inbox
    classDef domain stroke-width:1.5px;
    classDef store stroke-width:1.5px;
    classDef async stroke-width:1.5px;
Collection Escrita, consulta e identidade
gateway_openapi _id ObjectId, gatewayId, openapiJson, timestamps. Replace/upsert, leitura e exclusão por gatewayId; este identificador pode designar gateway ou template segundo a origem do evento
inbox_processed Insert de eventId string e processedAt; não há _id declarado no modelo nem consulta prévia de deduplicação no consumidor analisado

openapiJson é string, embora seu conteúdo represente um documento OpenAPI. DocumentationSource é seletor de processamento, não campo armazenado na entidade OpenApiDoc. DTOs obtidos de Core/Template não viram collections neste serviço. Não há índice secondary unique em gatewayId/eventId, nem TTL declarado no código próprio.

A mera existência de Inbox não garante processamento único. Eventos detalha a ordem de gravação e os limites de consistência; análise de dados registra as oportunidades de melhoria.

Fontes: projeção, Inbox, serviço, handler, consumidor.

Dicionário de documentos

Os nomes BSON abaixo respeitam @BsonId/@BsonProperty. A nulabilidade descreve o tipo Java, não uma validação de schema Mongo. Valores iniciais Java precedem os construtores e serviços; os defaults de criação e invariantes estão descritos acima. Referências anuláveis não significam que a API aceite omiti-las em todas as operações. Campos de mapas/documentos livres não possuem schema fechado no modelo.

Propriedades calculadas expostas por getters públicos são identificadas separadamente: fazem parte da superfície do codec POJO, não do estado independente da entidade. @BsonIgnore é respeitado. A representação UUID depende da configuração do codec; os tipos de transporte JSON não substituem os tipos BSON.

Collection / documento raiz Modelo
inbox_processed InboxProcessed
gateway_openapi OpenApiDoc

inbox_processed — InboxProcessed

InboxProcessed.

Campo BSON Tipo Java / estrutura Representação Nulabilidade / valor inicial
eventId String string Referência anulável; inicial Java: null
processedAt Instant data/hora Referência anulável; inicial Java: null

Exemplo de estrutura

Fragmento derivado dos campos do modelo vinculado acima, com valores substituídos por identificadores/textos sintéticos e data fixa. Não é um payload de criação nem um documento completo. ObjectId/data usam notação Extended JSON; nenhum dado de ambiente foi copiado.

{
  "eventId": "exemplo-id",
  "processedAt": {
    "$date": "2026-10-13T00:00:00Z"
  }
}

gateway_openapi — OpenApiDoc

OpenApiDoc.

Campo BSON Tipo Java / estrutura Representação Nulabilidade / valor inicial
_id ObjectId ObjectId Identificador BSON; tipo e geração conforme o ciclo de criação
gatewayId ObjectId ObjectId Referência anulável; inicial Java: null
openapiJson String string Referência anulável; inicial Java: null
createdAt Instant data/hora Referência anulável; inicial Java: null
updatedAt Instant data/hora Referência anulável; inicial Java: null

Exemplo de estrutura

Fragmento derivado dos campos do modelo vinculado acima, com valores substituídos por identificadores/textos sintéticos e data fixa. Não é um payload de criação nem um documento completo. ObjectId/data usam notação Extended JSON; nenhum dado de ambiente foi copiado.

{
  "_id": {
    "$oid": "000000000000000000000001"
  },
  "gatewayId": {
    "$oid": "000000000000000000000001"
  },
  "openapiJson": "exemplo-sanitizado",
  "createdAt": {
    "$date": "2026-10-13T00:00:00Z"
  }
}

Estruturas embutidas, herança e enums

Estes tipos não criam collections próprias. Quando uma entidade raiz aparece dentro de um snapshot, a mesma estrutura é embutida naquele caminho. Tipos de elementos de arrays e valores de mapas estão vinculados nas tabelas.