Merge pull request #750 from guspan-tanadi/settingsAPI-docs

style: formatting API-docs close parenthesis comment core/settings.py

application/core/settings.py

@@ -19,7 +19,7 @@ class Settings(BaseSettings):
     API_URL: str = "http://localhost:7091"  # backend url for celery worker
 
     API_KEY: str = None  # LLM api key
-    EMBEDDINGS_KEY: str = None  # api key for embeddings (if using openai, just copy API_KEY
+    EMBEDDINGS_KEY: str = None  # api key for embeddings (if using openai, just copy API_KEY)
     OPENAI_API_BASE: str = None  # azure openai api base url
     OPENAI_API_VERSION: str = None  # azure openai api version
     AZURE_DEPLOYMENT_NAME: str = None  # azure deployment name for answering

docs/pages/Developing/API-docs.md

@@ -55,6 +55,8 @@ This endpoint will make sure documentation is loaded on the server (just run it
 
 **Request:**
 
+**Method**: `POST`
+
 **Headers**: Content-Type should be set to `application/json; charset=utf-8`
 
 **Request Body**: JSON object with the field:
@@ -116,6 +118,7 @@ This endpoint is used to upload a file that needs to be trained, response is JSO
 **Request:**
 
 **Method**: `POST`
+
 **Request Body**: A multipart/form-data form with file upload and additional fields, including `user` and `name`.
 
 HTML example:
@@ -143,7 +146,9 @@ JSON response with a status and a task ID that can be used to check the task's p
 This endpoint is used to get the status of a task (`task_id`) from `/api/upload`
 
 **Request:**
-**Method**: `GE`T
+
+**Method**: `GET`
+
 **Query Parameter**: `task_id` (task ID to check)
 
 **Sample JavaScript Fetch Request:**