Merge pull request #264 from tisnik/lcore-304-rest-api

LCORE-304: REST API

Author: tisnik

README.md

@@ -469,3 +469,6 @@ make run-data-collector
 
 ![Configuration classes](docs/config.png)
 
+## REST API
+
+![REST API](docs/rest_api.png)

docs/rest_api.png

@@ -0,0 +1,33 @@
+@startuml
+
+participant Client
+participant "API Server"
+
+Client->>"API Server": GET /v1/info
+"API Server"-->>Client: InfoResponse
+
+Client->>"API Server": GET /v1/models
+"API Server"-->>Client: ModelsResponse
+
+Client->>"API Server": POST /v1/query (QueryRequest)
+"API Server"-->>Client: QueryResponse
+
+Client->>"API Server": POST /v1/streaming_query (QueryRequest)
+"API Server"-->>Client: StreamingQueryResponse
+
+Client->>"API Server": POST /v1/feedback (FeedbackRequest)
+"API Server"-->>Client: FeedbackResponse
+
+Client->>"API Server": GET /v1/conversation/{id}
+"API Server"-->>Client: ConversationResponse
+
+Client->>"API Server": DELETE /v1/conversation/{id}
+"API Server"-->>Client: ConversationDeleteResponse
+
+Client->>"API Server": GET /v1/ready
+"API Server"-->>Client: ReadinessResponse
+
+Client->>"API Server": GET /v1/live
+"API Server"-->>Client: LivenessResponse
+
+@enduml