Some doc fixes

Author: cybermaggedon

reference/apis/api-flow.md

@@ -16,17 +16,17 @@ complex data processing pipelines.
 
 The request contains the following fields:
 - `operation`: The operation to perform (see operations below)
-- `class_name`: Flow class name (for class operations and start-flow)
-- `class_definition`: Flow class definition JSON (for put-class)
+- `class-name`: Flow class name (for class operations and start-flow)
+- `class-definition`: Flow class definition JSON (for put-class)
 - `description`: Flow description (for start-flow)
-- `flow_id`: Flow instance ID (for flow instance operations)
+- `flow-id`: Flow instance ID (for flow instance operations)
 
 ### Response
 
 The response contains the following fields:
-- `class_names`: Array of flow class names (returned by list-classes)
-- `flow_ids`: Array of active flow IDs (returned by list-flows)
-- `class_definition`: Flow class definition JSON (returned by get-class)
+- `class-names`: Array of flow class names (returned by list-classes)
+- `flow-ids`: Array of active flow IDs (returned by list-flows)
+- `class-definition`: Flow class definition JSON (returned by get-class)
 - `flow`: Flow instance JSON (returned by get-flow)
 - `description`: Flow description (returned by get-flow)
 - `error`: Error information if operation fails
@@ -47,7 +47,7 @@ Request:
 Response:
 ```json
 {
-    "class_names": ["pdf-processor", "text-analyzer", "knowledge-extractor"]
+    "class-names": ["pdf-processor", "text-analyzer", "knowledge-extractor"]
 }
 ```
 
@@ -57,14 +57,14 @@ Request:
 ```json
 {
     "operation": "get-class",
-    "class_name": "pdf-processor"
+    "class-name": "pdf-processor"
 }
 ```
 
 Response:
 ```json
 {
-    "class_definition": "{\"interfaces\": {\"text-completion\": {\"request\": \"persistent://tg/request/text-completion\", \"response\": \"persistent://tg/response/text-completion\"}}, \"description\": \"PDF processing workflow\"}"
+    "class-definition": "{\"interfaces\": {\"text-completion\": {\"request\": \"persistent://tg/request/text-completion\", \"response\": \"persistent://tg/response/text-completion\"}}, \"description\": \"PDF processing workflow\"}"
 }
 ```
 
@@ -74,8 +74,8 @@ Request:
 ```json
 {
     "operation": "put-class",
-    "class_name": "pdf-processor",
-    "class_definition": "{\"interfaces\": {\"text-completion\": {\"request\": \"persistent://tg/request/text-completion\", \"response\": \"persistent://tg/response/text-completion\"}}, \"description\": \"PDF processing workflow\"}"
+    "class-name": "pdf-processor",
+    "class-definition": "{\"interfaces\": {\"text-completion\": {\"request\": \"persistent://tg/request/text-completion\", \"response\": \"persistent://tg/response/text-completion\"}}, \"description\": \"PDF processing workflow\"}"
 }
 ```
 
@@ -90,7 +90,7 @@ Request:
 ```json
 {
     "operation": "delete-class",
-    "class_name": "pdf-processor"
+    "class-name": "pdf-processor"
 }
 ```
 
@@ -113,7 +113,7 @@ Request:
 Response:
 ```json
 {
-    "flow_ids": ["flow-123", "flow-456", "flow-789"]
+    "flow-ids": ["flow-123", "flow-456", "flow-789"]
 }
 ```
 
@@ -123,7 +123,7 @@ Request:
 ```json
 {
     "operation": "get-flow",
-    "flow_id": "flow-123"
+    "flow-id": "flow-123"
 }
 ```
 
@@ -141,8 +141,8 @@ Request:
 ```json
 {
     "operation": "start-flow",
-    "class_name": "pdf-processor",
-    "flow_id": "flow-123",
+    "class-name": "pdf-processor",
+    "flow-id": "flow-123",
     "description": "Processing document batch 1"
 }
 ```
@@ -158,7 +158,7 @@ Request:
 ```json
 {
     "operation": "stop-flow",
-    "flow_id": "flow-123"
+    "flow-id": "flow-123"
 }
 ```
 
@@ -192,7 +192,7 @@ Response:
 {
     "id": "unique-request-id",
     "response": {
-        "class_names": ["pdf-processor", "text-analyzer"]
+        "class-names": ["pdf-processor", "text-analyzer"]
     },
     "complete": true
 }

reference/apis/api-knowledge.md

@@ -21,7 +21,7 @@ The request contains the following fields:
 - `flow`: Flow identifier (for load operations)
 - `collection`: Collection identifier (for load operations)
 - `triples`: RDF triples data (for put operations)
-- `graph_embeddings`: Graph embeddings data (for put operations)
+- `graph-embeddings`: Graph embeddings data (for put operations)
 
 ### Response
 
@@ -30,7 +30,7 @@ The response contains the following fields:
 - `ids`: Array of knowledge core IDs (returned by list operation)
 - `eos`: End of stream indicator for streaming responses
 - `triples`: RDF triples data (returned by get operation)
-- `graph_embeddings`: Graph embeddings data (returned by get operation)
+- `graph-embeddings`: Graph embeddings data (returned by get operation)
 
 ## Operations
 
@@ -61,7 +61,7 @@ Request:
             }
         ]
     },
-    "graph_embeddings": {
+    "graph-embeddings": {
         "metadata": {
             "id": "core-123",
             "user": "alice",
@@ -109,7 +109,7 @@ Response:
             }
         ]
     },
-    "graph_embeddings": {
+    "graph-embeddings": {
         "metadata": {
             "id": "core-123",
             "user": "alice",

reference/apis/api-librarian.md

@@ -16,11 +16,11 @@ Cassandra for metadata) with multi-user support.
 
 The request contains the following fields:
 - `operation`: The operation to perform (see operations below)
-- `document_id`: Document identifier (for document operations)
-- `document_metadata`: Document metadata object (for add/update operations)
+- `document-id`: Document identifier (for document operations)
+- `document-metadata`: Document metadata object (for add/update operations)
 - `content`: Document content as base64-encoded bytes (for add operations)
-- `processing_id`: Processing job identifier (for processing operations)
-- `processing_metadata`: Processing metadata object (for add-processing)
+- `processing-id`: Processing job identifier (for processing operations)
+- `processing-metadata`: Processing metadata object (for add-processing)
 - `user`: User identifier (required for most operations)
 - `collection`: Collection filter (optional for list operations)
 - `criteria`: Query criteria array (for filtering operations)
@@ -29,10 +29,10 @@ The request contains the following fields:
 
 The response contains the following fields:
 - `error`: Error information if operation fails
-- `document_metadata`: Single document metadata (for get operations)
+- `document-metadata`: Single document metadata (for get operations)
 - `content`: Document content as base64-encoded bytes (for get-content)
-- `document_metadatas`: Array of document metadata (for list operations)
-- `processing_metadatas`: Array of processing metadata (for list-processing)
+- `document-metadatas`: Array of document metadata (for list operations)
+- `processing-metadatas`: Array of processing metadata (for list-processing)
 
 ## Document Operations
 
@@ -42,7 +42,7 @@ Request:
 ```json
 {
     "operation": "add-document",
-    "document_metadata": {
+    "document-metadata": {
         "id": "doc-123",
         "time": 1640995200000,
         "kind": "application/pdf",
@@ -73,15 +73,15 @@ Request:
 ```json
 {
     "operation": "get-document-metadata",
-    "document_id": "doc-123",
+    "document-id": "doc-123",
     "user": "alice"
 }
 ```
 
 Response:
 ```json
 {
-    "document_metadata": {
+    "document-metadata": {
         "id": "doc-123",
         "time": 1640995200000,
         "kind": "application/pdf",
@@ -106,7 +106,7 @@ Request:
 ```json
 {
     "operation": "get-document-content",
-    "document_id": "doc-123",
+    "document-id": "doc-123",
     "user": "alice"
 }
 ```
@@ -132,7 +132,7 @@ Request:
 Response:
 ```json
 {
-    "document_metadatas": [
+    "document-metadatas": [
         {
             "id": "doc-123",
             "time": 1640995200000,
@@ -161,7 +161,7 @@ Request:
 ```json
 {
     "operation": "update-document",
-    "document_metadata": {
+    "document-metadata": {
         "id": "doc-123",
         "title": "Updated Research Paper",
         "comments": "Updated findings and conclusions",
@@ -182,7 +182,7 @@ Request:
 ```json
 {
     "operation": "remove-document",
-    "document_id": "doc-123",
+    "document-id": "doc-123",
     "user": "alice"
 }
 ```
@@ -200,9 +200,9 @@ Request:
 ```json
 {
     "operation": "add-processing",
-    "processing_metadata": {
+    "processing-metadata": {
         "id": "proc-456",
-        "document_id": "doc-123",
+        "document-id": "doc-123",
         "time": 1640995400000,
         "flow": "pdf-extraction",
         "user": "alice",
@@ -231,10 +231,10 @@ Request:
 Response:
 ```json
 {
-    "processing_metadatas": [
+    "processing-metadatas": [
         {
             "id": "proc-456",
-            "document_id": "doc-123",
+            "document-id": "doc-123",
             "time": 1640995400000,
             "flow": "pdf-extraction",
             "user": "alice",
@@ -251,7 +251,7 @@ Request:
 ```json
 {
     "operation": "remove-processing",
-    "processing_id": "proc-456",
+    "processing-id": "proc-456",
     "user": "alice"
 }
 ```
@@ -287,7 +287,7 @@ Response:
 {
     "id": "unique-request-id",
     "response": {
-        "document_metadatas": [...]
+        "document-metadatas": [...]
     },
     "complete": true
 }