Register Namespace¶
Overview¶
To register namespace for convention within project
Convention¶
Convention seperated into: CRUD, API, Filterset
For CRUD:
ORM Table: upper case with _. Example: INNO_QUOTE
Function: lower case with _. Example: fetch_dataset
For the API:
Method: using lower case with seperated with /
Map Function: using camel case
Mapping Functional¶
The table map between method and function
| Method | Map function | Description |
|---|---|---|
HEAD */* | metadata[<DATASET>] | Fetch metadata of dataset without content included |
GET */* | fetch[<DATASET>] | Fetch records from dataset based on filterset |
POST */* | add[<DATASET>] | Add a single record into dataset |
PUT */* | modify[<DATASET>] | Modify a single record into dataset |
DELETE */* | remove[<DATASET>] | Delete records from dataset based on filterset |
DELETE */*/uuids/{uuid:str} | remove[<DATASET>]ByUuid | Delete record by UUID |
PUT */*/upload | load[<DATASET>]FromExternalFile | Upload multiple records from external file (csv, xlsx, parquet) |
PUT /*/*/uuids/{uuid:str}/{action:str} | approval[<DATASET>]ByUuid | Appovals for the request of changes |
POST /*/*/bulk/insert | bulkInsert[<DATASET>] | Bulk insert multiple records into dataset |
POST /*/*/bulk/update | bulkUpdate[<DATASET>] | Bulk update multiple records into dataset |
which */* meaning seperated namespace to identity the resource
and [<DATASET>] is in a camel case of dataset (or pipeline)