Regenerate documentation with conntrack changes

web/docs/interfaces/Fields.md

@@ -138,6 +138,14 @@ L4 protocol
 
 ___
 
+### Interface
+
+• `Optional` **Interface**: `string`
+
+Network interface
+
+___
+
 ### Packets
 
 • **Packets**: `number`
@@ -146,6 +154,22 @@ Number of packets in this flow
 
 ___
 
+### Packets\_AB
+
+• `Optional` **Packets\_AB**: `number`
+
+In conversation tracking, A to B packets counter per conversation
+
+___
+
+### Packets\_BA
+
+• `Optional` **Packets\_BA**: `number`
+
+In conversation tracking, B to A packets counter per conversation
+
+___
+
 ### Bytes
 
 • **Bytes**: `number`
@@ -154,6 +178,22 @@ Number of bytes in this flow
 
 ___
 
+### Bytes\_AB
+
+• `Optional` **Bytes\_AB**: `number`
+
+In conversation tracking, A to B bytes counter per conversation
+
+___
+
+### Bytes\_BA
+
+• `Optional` **Bytes\_BA**: `number`
+
+In conversation tracking, B to A bytes counter per conversation
+
+___
+
 ### TimeFlowStartMs
 
 • **TimeFlowStartMs**: `number`
@@ -175,3 +215,27 @@ ___
 • **TimeReceived**: `number`
 
 Timestamp when this flow was received and processed by the flow collector, in seconds
+
+___
+
+### \_HashId
+
+• `Optional` **\_HashId**: `string`
+
+In conversation tracking, the conversation identifier
+
+___
+
+### \_IsFirst
+
+• `Optional` **\_IsFirst**: `string`
+
+In conversation tracking, a flag identifying the first flow
+
+___
+
+### numFlowLogs
+
+• `Optional` **numFlowLogs**: `number`
+
+In conversation tracking, a counter of flow logs per conversation

web/docs/interfaces/Labels.md

@@ -39,3 +39,12 @@ ___
 • **FlowDirection**: [`FlowDirection`](../enums/FlowDirection.md)
 
 Flow direction from the node observation point
+
+___
+
+### \_RecordType
+
+• `Optional` **\_RecordType**: `RecordType`
+
+Type of record: 'flowLog' for regular flow logs, or 'allConnections',
+'newConnection', 'heartbeat', 'endConnection' for conversation tracking

web/src/api/ipfix.ts

@@ -1,5 +1,9 @@
 import { RecordType } from '../model/flow-query';
 
+// Please keep this file documented: it is used in doc generation
+// To regenerate doc, run `make generate-doc` - and also check this page:
+// https://github.com/netobserv/network-observability-operator/blob/main/docs/GeneratingAsciidocAPI.md#generate-asciidoc-for-flows-json-format-reference
+
 export interface Record {
   labels: Labels;
   key: number;
@@ -17,6 +21,8 @@ export interface Labels {
   DstK8S_OwnerName?: string;
   /** Flow direction from the node observation point */
   FlowDirection: FlowDirection;
+  /** Type of record: 'flowLog' for regular flow logs, or 'allConnections',
+   * 'newConnection', 'heartbeat', 'endConnection' for conversation tracking */
   _RecordType?: RecordType;
 }
 
@@ -62,22 +68,30 @@ export interface Fields {
   DstK8S_HostName?: string;
   /** L4 protocol */
   Proto: number;
+  /** Network interface */
+  Interface?: string;
   /** Number of packets in this flow */
   Packets: number;
+  /** In conversation tracking, A to B packets counter per conversation */
   Packets_AB?: number;
+  /** In conversation tracking, B to A packets counter per conversation */
   Packets_BA?: number;
   /** Number of bytes in this flow */
   Bytes: number;
+  /** In conversation tracking, A to B bytes counter per conversation */
   Bytes_AB?: number;
+  /** In conversation tracking, B to A bytes counter per conversation */
   Bytes_BA?: number;
   /** Start timestamp of this flow, in milliseconds */
   TimeFlowStartMs: number;
   /** End timestamp of this flow, in milliseconds */
   TimeFlowEndMs: number;
   /** Timestamp when this flow was received and processed by the flow collector, in seconds */
   TimeReceived: number;
+  /** In conversation tracking, the conversation identifier */
   _HashId?: string;
+  /** In conversation tracking, a flag identifying the first flow */
   _IsFirst?: string;
+  /** In conversation tracking, a counter of flow logs per conversation */
   numFlowLogs?: number;
-  Interface?: string;
 }