From 71aa0b80a8c43aa069f29d5b0bd4e191484320eb Mon Sep 17 00:00:00 2001 From: oof1lab Date: Sun, 12 Nov 2017 20:12:12 +0530 Subject: [PATCH] doc : update --- README.md | 45 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 33da73d6b7..d2abe74e1f 100644 --- a/README.md +++ b/README.md @@ -94,18 +94,8 @@ Root URL (localhost:3000/) returns all REST API urls for each table in schema. ## CRUD APIs Usual Suspects -* GET       /api/tableName -* POST      /api/tableName -* PUT       /api/tableName ( acts as REPLACE ) -* GET       /api/tableName/:id -* PATCH       /api/tableName/:id ( acts as UPDATE ) -* GET       /api/tableName/findOne -* GET       /api/tableName/count -* GET       /api/tableName/:id/exists -* GET       /api/parentTable/:id/childTable -* DELETE  /api/tableName/:id - -| HTTP Type | API URL | Comments | + +| HTTP Type | API URL | Comments | |-----------|----------------------------------|--------------------------------------------------------- | GET | /api/tableName | Lists rows of table | | POST | /api/tableName | Create a new row | @@ -115,22 +105,29 @@ Root URL (localhost:3000/) returns all REST API urls for each table in schema. | 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 | - +| DELETE | /api/tableName/:id | Delete a row by primary key | +| GET | /api/parentTable/:id/childTable | Get list of child table with paren table foreign key | ## APIs with HOT features -* GET       /api/tableName/aggregate -* GET       /api/tableName/groupby :fire::fire: -* GET       /api/tableName/ugroupby :fire::fire: **[ HOTNESS ALERT ]** -* GET       /api/tableName/chart :fire::fire: **[ HOTNESS ALERT ]** + +| HTTP Type | API URL | Comments | +|-----------|----------------------------------|--------------------------------------------------------- +| GET | /api/tableName/aggregate | Aggregate results of numeric column(s) | +| GET :fire:| /api/tableName/groupby | Group by results of column(s) | +| GET :fire:| /api/tableName/ugroupby | Multiple group by results using one call | +| GET :fire:| /api/tableName/chart | Numeric column distribution based on (min,max,step) or(step array) or (automagic)| + ## APIs for Prototyping :snowboarder: :snowboarder: -* POST     /dynamic -* POST       /upload -* POST       /uploads -* GET       /download -* GET      /api/tableName/describe -* GET      /api/tables +| HTTP Type | API URL | Comments | +|-----------|----------------------------------|--------------------------------------------------------- +| GET :fire:| /dynamic | execute dynamic mysql statements with params | +| GET :fire:| /upload | upload single file | +| GET :fire:| /uploads | upload multiple files | +| GET :fire:| /download | download a file | +| GET :fire:| /api/tableName/describe | describe each table for its columns | +| GET :fire:| /api/tables | get all tables in database | + ## Relational Tables