@sigmaott/base-next 1.0.6

package/src/schemas/chatApi.json

@@ -0,0 +1,497 @@
+{
+  "openapi": "3.0.0",
+  "paths": {
+    "/{resourceId}": {
+      "get": {
+        "operationId": "ChatController_getThreadList",
+        "summary": "Get list of threads for a resource",
+        "parameters": [
+          {
+            "name": "resourceId",
+            "required": true,
+            "in": "path",
+            "description": "Resource ID",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "limit",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "number"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Returns a list of threads with title and ID"
+          },
+          "500": {
+            "description": "Server error"
+          }
+        },
+        "tags": [
+          "Chat Controller"
+        ]
+      },
+      "post": {
+        "operationId": "ChatController_createThread",
+        "summary": "Create a new thread for a resource",
+        "parameters": [
+          {
+            "name": "resourceId",
+            "required": true,
+            "in": "path",
+            "description": "Resource ID",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "Returns the created thread ID"
+          },
+          "500": {
+            "description": "Server error"
+          }
+        },
+        "tags": [
+          "Chat Controller"
+        ]
+      }
+    },
+    "/{resourceId}/conversation/{conversationId}": {
+      "get": {
+        "operationId": "ChatController_getThreadMessages",
+        "summary": "Get messages for a specific thread",
+        "parameters": [
+          {
+            "name": "resourceId",
+            "required": true,
+            "in": "path",
+            "description": "Resource ID",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "conversationId",
+            "required": true,
+            "in": "path",
+            "description": "Thread ID",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Returns the conversation messages"
+          },
+          "400": {
+            "description": "Bad request if threadId or resourceId is missing"
+          }
+        },
+        "tags": [
+          "Chat Controller"
+        ]
+      },
+      "patch": {
+        "operationId": "ChatController_updateConversationTitle",
+        "summary": "Update conversation title",
+        "parameters": [
+          {
+            "name": "resourceId",
+            "required": true,
+            "in": "path",
+            "description": "Resource ID",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "conversationId",
+            "required": true,
+            "in": "path",
+            "description": "Conversation ID",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateConversationDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Returns the updated conversation"
+          },
+          "404": {
+            "description": "Conversation not found"
+          },
+          "500": {
+            "description": "Server error"
+          }
+        },
+        "tags": [
+          "Chat Controller"
+        ]
+      },
+      "delete": {
+        "operationId": "ChatController_deleteConversation",
+        "summary": "Delete a conversation",
+        "parameters": [
+          {
+            "name": "resourceId",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "conversationId",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "description": "Conversation ID to delete",
+            "schema": {}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Conversation successfully deleted"
+          },
+          "400": {
+            "description": "Bad request if conversation deletion fails"
+          }
+        },
+        "tags": [
+          "Chat Controller"
+        ]
+      }
+    },
+    "/stream": {
+      "post": {
+        "operationId": "ChatController_aiSdkStream",
+        "summary": "Stream a chat response",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ChatRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Streams the AI response"
+          },
+          "500": {
+            "description": "Server error"
+          }
+        },
+        "tags": [
+          "Chat Controller"
+        ]
+      }
+    },
+    "/rag/document": {
+      "post": {
+        "operationId": "RagController_addDocument",
+        "parameters": [],
+        "responses": {
+          "201": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/rag/search": {
+      "get": {
+        "operationId": "RagController_searchDocuments",
+        "parameters": [
+          {
+            "name": "query",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "limit",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "number"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/health": {
+      "get": {
+        "operationId": "HealthController_check",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The Health Check is successful",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "example": "ok"
+                    },
+                    "info": {
+                      "type": "object",
+                      "example": {
+                        "database": {
+                          "status": "up"
+                        }
+                      },
+                      "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                          "status": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      },
+                      "nullable": true
+                    },
+                    "error": {
+                      "type": "object",
+                      "example": {},
+                      "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                          "status": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      },
+                      "nullable": true
+                    },
+                    "details": {
+                      "type": "object",
+                      "example": {
+                        "database": {
+                          "status": "up"
+                        }
+                      },
+                      "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                          "status": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "The Health Check is not successful",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "example": "error"
+                    },
+                    "info": {
+                      "type": "object",
+                      "example": {
+                        "database": {
+                          "status": "up"
+                        }
+                      },
+                      "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                          "status": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      },
+                      "nullable": true
+                    },
+                    "error": {
+                      "type": "object",
+                      "example": {
+                        "redis": {
+                          "status": "down",
+                          "message": "Could not connect"
+                        }
+                      },
+                      "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                          "status": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      },
+                      "nullable": true
+                    },
+                    "details": {
+                      "type": "object",
+                      "example": {
+                        "database": {
+                          "status": "up"
+                        },
+                        "redis": {
+                          "status": "down",
+                          "message": "Could not connect"
+                        }
+                      },
+                      "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                          "status": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "info": {
+    "title": "Mastra RAG API",
+    "description": "API documentation for Mastra RAG chatbot",
+    "version": "1.0",
+    "contact": {}
+  },
+  "tags": [
+    {
+      "name": "chat",
+      "description": "Chat endpoints"
+    },
+    {
+      "name": "rag",
+      "description": "RAG endpoints"
+    }
+  ],
+  "servers": [],
+  "components": {
+    "schemas": {
+      "UpdateConversationDto": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string",
+            "description": "The new title for the conversation",
+            "example": "My updated conversation title"
+          }
+        },
+        "required": [
+          "title"
+        ]
+      },
+      "CoreMessageDto": {
+        "type": "object",
+        "properties": {
+          "role": {
+            "type": "string",
+            "description": "Role of the message sender",
+            "example": "user",
+            "enum": [
+              "user",
+              "assistant",
+              "system"
+            ]
+          },
+          "content": {
+            "type": "object",
+            "description": "Content of the message",
+            "additionalProperties": true
+          }
+        },
+        "required": [
+          "role",
+          "content"
+        ]
+      },
+      "ChatRequest": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "description": "The message to send",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/CoreMessageDto"
+              }
+            ]
+          },
+          "conversationId": {
+            "type": "string",
+            "description": "Conversation ID for continuing an existing conversation",
+            "example": "conv-123456"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      }
+    }
+  }
+}