From a4187894b2830e5898f3d3633892ca6ccce87bd7 Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Wed, 1 Dec 2021 13:57:07 +0000 Subject: [PATCH] update db examples and readmes --- db/README.md | 2 +- db/examples.json | 20 ++++++++++---------- user/README.md | 5 +++-- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/db/README.md b/db/README.md index 0bb2483..a10364f 100644 --- a/db/README.md +++ b/db/README.md @@ -2,5 +2,5 @@ Simple database service # DB Service -The DB service is a straightforward key-value and document database which provides persistent storage via a CRUD interface. It includes feature rich querying and JSON based formatted records for native use in Node.js and or any language. Powering the backend of your apps from anywhere in the world. +The DB service is an easy to use database which provides persistent storage via a CRUD interface. It includes feature rich querying and JSON based formatted records for native use in Node.js and or any language. Powering the backend of your apps from anywhere in the world. diff --git a/db/examples.json b/db/examples.json index 468a008..afc2429 100644 --- a/db/examples.json +++ b/db/examples.json @@ -4,7 +4,7 @@ "title": "Create a record", "run_check": true, "request": { - "table": "users", + "table": "people", "record": { "id": "1", "name": "Jane", @@ -22,7 +22,7 @@ "title": "Update a record", "run_check": true, "request": { - "table": "users", + "table": "example", "record": { "id": "1", "age": 43 @@ -37,7 +37,7 @@ "run_check": true, "idempotent": true, "request": { - "table": "users", + "table": "example", "query": "age == 43" }, "response": { @@ -57,7 +57,7 @@ "title": "Delete a record", "run_check": true, "request": { - "table": "users", + "table": "example", "id": "1" }, "response": {} @@ -68,7 +68,7 @@ "title": "Truncate table", "run_check": false, "request": { - "table": "users" + "table": "example" }, "response": {} } @@ -78,7 +78,7 @@ "title": "Drop table", "run_check": false, "request": { - "table": "users" + "table": "example" }, "response": {} } @@ -88,7 +88,7 @@ "title": "Count entries in a table", "run_check": false, "request": { - "table": "users" + "table": "example" }, "response": { "count": 31 @@ -101,7 +101,7 @@ "run_check": false, "request": {}, "response": { - "tables": ["users", "events"] + "tables": ["example", "example2"] } } ], @@ -110,8 +110,8 @@ "title": "Rename table", "run_check": false, "request": { - "from": "events", - "to": "events_backup" + "from": "examples2", + "to": "examples3" }, "response": {} } diff --git a/user/README.md b/user/README.md index b45cf57..f5a129c 100644 --- a/user/README.md +++ b/user/README.md @@ -2,5 +2,6 @@ User management and authentication # User Service -The user service provides user account management and authentication - +The user service provides user account management and authentication. It includes the ability to +send verification and password reset emails. All data is stored in the DB service under the "users" +table.