From 06faf3f39a0a5c75f43e2d9499c674c502807e34 Mon Sep 17 00:00:00 2001 From: Naveen MR Date: Thu, 26 Aug 2021 12:31:29 +0530 Subject: [PATCH] fix : api docs Signed-off-by: Naveen MR --- .../en/developer-resources/rest-apis.md | 30 ++++++++++--------- packages/noco-docs/content/en/index.md | 2 +- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/packages/noco-docs/content/en/developer-resources/rest-apis.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md index 34ff8c30f3..21db36913f 100644 --- a/packages/noco-docs/content/en/developer-resources/rest-apis.md +++ b/packages/noco-docs/content/en/developer-resources/rest-apis.md @@ -28,7 +28,7 @@ menuTitle: 'REST APIs' * Access Control -## API Overview +## Data APIs | **Method** | **Path** | **Query Params** | **Description** | |---|---|---|---| @@ -56,7 +56,20 @@ menuTitle: 'REST APIs' -### HasMany APIs +### Query params + + +| **Name** | **Alias** | **Use case** | **Default value** |**Example value** | +|---|---|---|---|---| +| [where](#comparison-operators) | [w](#comparison-operators) | Complicated where conditions | | `(colName,eq,colValue)~or(colName2,gt,colValue2)`
[Usage: Comparison operators](#comparison-operators)
[Usage: Logical operators](#logical-operators) | +| limit | l | Number of rows to get(SQL limit value) | 10 | 20 | +| offset | o | Offset for pagination(SQL offset value) | 0 | 20 | +| sort | s | Sort by column name, Use `-` as prefix for descending sort | | column_name | +| fields | f | Required column names in result | * | column_name1,column_name2 | +| fields1 | f1 | Required column names in child result | * | column_name1,column_name2 | + + +## HasMany APIs | **Method** | **Path** | **Query Params** | **Description** | |---|---|---|---| @@ -77,7 +90,7 @@ menuTitle: 'REST APIs' -### BelongsTo APIs +## BelongsTo APIs | **Method** | **Path** | **Query Params** | **Description** | |---|---|---|---| @@ -91,17 +104,6 @@ menuTitle: 'REST APIs' -### Query params - - -| **Name** | **Alias** | **Use case** | **Default value** |**Example value** | -|---|---|---|---|---| -| [where](#comparison-operators) | [w](#comparison-operators) | Complicated where conditions | | `(colName,eq,colValue)~or(colName2,gt,colValue2)`
[Usage: Comparison operators](#comparison-operators)
[Usage: Logical operators](#logical-operators) | -| limit | l | Number of rows to get(SQL limit value) | 10 | 20 | -| offset | o | Offset for pagination(SQL offset value) | 0 | 20 | -| sort | s | Sort by column name, Use `-` as prefix for descending sort | | column_name | -| fields | f | Required column names in result | * | column_name1,column_name2 | -| fields1 | f1 | Required column names in child result | * | column_name1,column_name2 | #### Comparison operators diff --git a/packages/noco-docs/content/en/index.md b/packages/noco-docs/content/en/index.md index 7cdc9f836b..ee1468e567 100644 --- a/packages/noco-docs/content/en/index.md +++ b/packages/noco-docs/content/en/index.md @@ -62,7 +62,7 @@ Our mission is to provide the most powerful no-code interface for databases whic | Create new project | NC_DB | NC_DB | | Create new project with external DB | NC_DB | External database | -## Project Structures +## NocoDB repository structure We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages).