feat: Adding meta-groups and meta-data endpoints
This commit is contained in:
21
README.md
21
README.md
@@ -22,13 +22,26 @@ Example:
|
||||
|
||||
Read registered resources:
|
||||
|
||||
- `/cities`: List registered cities.
|
||||
- `/countries`: List registered countries.
|
||||
- `/product-categories`: List registered product-categories.
|
||||
- `/states`: List registered states.
|
||||
- `GET /countries`: List registered countries.
|
||||
- `GET /cities`: List registered cities.
|
||||
- `GET /meta-data`: List registered meta-data.
|
||||
- `GET /meta-groups`: List registered meta-data.
|
||||
- `GET /product-categories`: List registered product-categories.
|
||||
- `GET /states`: List registered states.
|
||||
|
||||
All these endpoints support the following parameters:
|
||||
|
||||
- `/` : List registered resources with pagination.
|
||||
- `/:id` : Read specific resource identified by Id.
|
||||
- `/find?regex=xxx` : List resources that matches with regex (support pagination).
|
||||
|
||||
## Private Endpoints
|
||||
|
||||
The following list of endpoints requires a JWT.
|
||||
|
||||
## Test Endpoint
|
||||
|
||||
A private endpoint to test the JWT and the api response.
|
||||
|
||||
- `POST /apitest`: Return whatever is sent on the body, queries and parameters.
|
||||
- `GET /version`: Return the API version.
|
||||
Reference in New Issue
Block a user