diff --git a/docs/api-examples.md b/docs/api-examples.md index 0f144f4..d83ba40 100644 --- a/docs/api-examples.md +++ b/docs/api-examples.md @@ -11,7 +11,9 @@ To follow the below examples we need to download a sample database and also inst ```bash wget https://raw.githubusercontent.com/lerocha/chinook-database/master/ChinookDatabase/DataSources/Chinook_Sqlite.sqlite # Download sample sqlite database ``` + ### Using Soul CLI + ```bash npm install -g soul-cli soul -d ./Chinook_Sqlite.sqlite -p 8000 @@ -26,15 +28,14 @@ npm install # Install dependencies npm link # might need `sudo` soul -d ./Chinook_Sqlite.sqlite -p 8000 ``` - + ## Namespaces -1. [/api/tables](/docs/api/tables-examples.md) Examples for Tables endpoints -2. [/api/rows](/docs/api/rows-examples.md) Examples for Rows endpoints -3. [/api/](/docs/api/root-examples.md) Examples for Root endpoints - +1. [/api/tables](docs/api/tables-examples.md) Examples for Tables endpoints +2. [/api/rows](docs/api/rows-examples.md) Examples for Rows endpoints +3. [/api/](docs/api/root-examples.md) Examples for Root endpoints ## Handling Errors @@ -54,9 +55,9 @@ curl --request POST \ ```json { - "message": "table artists already exists", - "error": { - "code": "SQLITE_ERROR" - } + "message": "table artists already exists", + "error": { + "code": "SQLITE_ERROR" + } } ``` diff --git a/docs/ws-examples.md b/docs/ws-examples.md index 8663e7b..e157658 100644 --- a/docs/ws-examples.md +++ b/docs/ws-examples.md @@ -20,6 +20,7 @@ npm i -g wscat # Install websocket client ``` ### Using Soul CLI + ```bash npm install -g soul-cli soul -d ./Chinook_Sqlite.sqlite -p 8000 @@ -34,9 +35,9 @@ npm install # Install dependencies npm link # might need `sudo` soul -d ./Chinook_Sqlite.sqlite -p 8000 ``` - + ## Namespaces -1. [/ws/tables](/docs/ws/rows-examples.md) Examples for Rows websockets +1. [/ws/tables](docs/ws/rows-examples.md) Examples for Rows websockets