From 7fba22d85aba6077b96a584142cf4174d8ebd9ac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Juan=20Carlos=20Jos=C3=A9=20Camacho?= <jcjc712@hotmail.com>
Date: Thu, 14 Sep 2023 11:36:02 -0600
Subject: [PATCH] DH-4656 Update readme file (#163)

---
 README.md | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 9185e9bb..abbfc405 100644
--- a/README.md
+++ b/README.md
@@ -160,7 +160,7 @@ You can define a DB connection through a call to the following API endpoint `/ap
 Example 1. Without a SSH connection
 ```
 curl -X 'POST' \
-  '<host>/api/v1/database' \
+  '<host>/api/v1/database-connections' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -174,7 +174,7 @@ curl -X 'POST' \
 Example 2. With a SSH connection
 ```
 curl -X 'POST' \
-  'http://localhost/api/v1/database' \
+  '<host>/api/v1/database-connections' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -247,21 +247,21 @@ Once you have connected to the data warehouse, you should add context to the eng
 While only the Database scan part is required to start generating SQL, adding verified SQL and string descriptions are also important for the tool to generate accurate SQL. 
 
 #### Scanning the Database
-The database scan is used to gather information about the database including table and column names and identifying low cardinality columns and their values to be stored in the context store and used in the prompts to the LLM. You can trigger a scan of a database from the `POST /api/v1/scanner` endpoint. Example below
+The database scan is used to gather information about the database including table and column names and identifying low cardinality columns and their values to be stored in the context store and used in the prompts to the LLM. You can trigger a scan of a database from the `POST /api/v1/table-descriptions/scan` endpoint. Example below
 
 
 ```
 curl -X 'POST' \
-  '<host>/api/v1/scanner' \
+  '<host>/api/v1/table-descriptions/scan' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
     "db_connection_id": "db_connection_id",
-    "table_name": "table_name"
+    "table_names": ["table_name"]
   }'
 ```
 
-Since the endpoint identifies low cardinality columns (and their values) it can take time to complete. Therefore while it is possible to trigger a scan on the entire DB by not specifying the `table_name`, we recommend against it for large databases. 
+Since the endpoint identifies low cardinality columns (and their values) it can take time to complete. Therefore while it is possible to trigger a scan on the entire DB by not specifying the `table_names`, we recommend against it for large databases. 
 
 #### Get a scanned db
 Once a database was scanned you can use this endpoint to retrieve the tables names and columns
@@ -269,16 +269,16 @@ Once a database was scanned you can use this endpoint to retrieve the tables nam
 
 ```
 curl -X 'GET' \
-    '<host>/api/v1/scanned-databases?db_connection_id=64dfa0e103f5134086f7090c' \
-    -H 'accept: application/json'
+  '<host>/api/v1/table-descriptions?db_connection_id=64dfa0e103f5134086f7090c&table_name=foo' \
+  -H 'accept: application/json'
 ```
 
 #### Adding verified SQL
-Sample NL<>SQL pairs (golden SQL) can be stored in the context store and used for few-shot in context learning. In the default context store and NL 2 SQL engine, these samples are stored in a vector store and the closest samples are retrieved for few shot learning. You can add golden SQL to the context store from the `POST /api/v1/golden-record` endpoint
+Sample NL<>SQL pairs (golden SQL) can be stored in the context store and used for few-shot in context learning. In the default context store and NL 2 SQL engine, these samples are stored in a vector store and the closest samples are retrieved for few shot learning. You can add golden SQL to the context store from the `POST /api/v1/golden-records` endpoint
 
 ```
 curl -X 'POST' \
-  '<host>/api/v1/golden-record' \
+  '<host>/api/v1/golden-records' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '[
@@ -291,11 +291,11 @@ curl -X 'POST' \
 ```
 
 #### Adding string descriptions
-In addition to database table_info and golden_sql, you can add strings describing tables and/or columns to the context store manually from the `PATCH /api/v1/scanned-db/{db_connection_id}/{table_name}` endpoint
+In addition to database table_info and golden_sql, you can add strings describing tables and/or columns to the context store manually from the `PATCH /api/v1/table-descriptions/{table_description_id}` endpoint
 
 ```
 curl -X 'PATCH' \
-  '<host>/api/v1/scanned-db/db_connection_id/table_name' \
+  '<host>/api/v1/table-descriptions/64dfa0e103f5134086f7090c' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{