From 64c9cf960d0e89ec8739e07c65a98c15e3cbed49 Mon Sep 17 00:00:00 2001 From: oof1lab Date: Sun, 12 Nov 2017 19:58:12 +0530 Subject: [PATCH] doc : update --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 5b86bce697..f815e2eb78 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,20 @@ Root URL (localhost:3000/) returns all REST API urls for each table in schema. * GET       /api/parentTable/:id/childTable * DELETE  /api/tableName/:id +|-----------|----------------------------------|--------------------------------------------------------- +| HTTP Type | API URL | Comments +|-----------|----------------------------------|--------------------------------------------------------- +| GET | /api/tableName | Lists rows of table +| POST | /api/tableName | Create a new row +| PUT | /api/tableName | Replaces existing row with new row +| GET | /api/tableName/:id | Retrieves a row by primary key +| PATCH | /api/tableName/:id | Updates a row by primary key +| GET | /api/tableName/findOne | Works as list but gets single record matching criteria +| GET | /api/tableName/count | Count number of rows in a table +| GET | /api/tableName/:id/exists | True or false whether a row exists or not +| DELETE | /api/parentTable/:id/childTable | Delete a row by primary key +|-----------|----------------------------------|--------------------------------------------------------- + ## APIs with HOT features * GET       /api/tableName/aggregate * GET       /api/tableName/groupby :fire::fire: