readme update
This commit is contained in:
20
README.md
20
README.md
@@ -8,6 +8,7 @@ This README aims to document functionality of backend as well as required steps
|
|||||||
- [Location Data](#location-data)
|
- [Location Data](#location-data)
|
||||||
- [Endpoints](#endpoints)
|
- [Endpoints](#endpoints)
|
||||||
- [Data Load](#data-load)
|
- [Data Load](#data-load)
|
||||||
|
- [Development Utils](#development-utils)
|
||||||
|
|
||||||
## First Steps
|
## First Steps
|
||||||
|
|
||||||
@@ -100,8 +101,11 @@ Refresh expired token endpoint: `/api/v1/token/refresh/`
|
|||||||
|
|
||||||
Endpoint url: `/api/v1/users/`
|
Endpoint url: `/api/v1/users/`
|
||||||
|
|
||||||
|
To get info on authenticated user: `/api/v1/my_user/`
|
||||||
|
|
||||||
Authenticated users cannot create new users
|
Authenticated users cannot create new users
|
||||||
User are inactive by default
|
|
||||||
|
User are active by default
|
||||||
|
|
||||||
To create user:
|
To create user:
|
||||||
```json
|
```json
|
||||||
@@ -118,10 +122,13 @@ To create user:
|
|||||||
|
|
||||||
Endpoint url: `/api/v1/companies/`
|
Endpoint url: `/api/v1/companies/`
|
||||||
|
|
||||||
|
To get company linked to authenticated user: `/api/v1/my_company/`
|
||||||
|
|
||||||
### Products
|
### Products
|
||||||
|
|
||||||
Endpoint url: `/api/v1/products/`
|
Endpoint url: `/api/v1/products/`
|
||||||
|
|
||||||
|
To get products linked to authenticated user: `/api/v1/my_products/`
|
||||||
|
|
||||||
### History
|
### History
|
||||||
|
|
||||||
@@ -166,3 +173,14 @@ For massive load of product data.
|
|||||||
CSV headers: `id,nombre-producto,descripcion,imagen,url,precio,gastos-envio,cond-envio,descuento,stock,tags,categoria,identificadores`
|
CSV headers: `id,nombre-producto,descripcion,imagen,url,precio,gastos-envio,cond-envio,descuento,stock,tags,categoria,identificadores`
|
||||||
|
|
||||||
Only admin users have access to endoint
|
Only admin users have access to endoint
|
||||||
|
|
||||||
|
|
||||||
|
## Development Utils
|
||||||
|
|
||||||
|
### Fake product load
|
||||||
|
|
||||||
|
To create a dataset of fake companies and products:
|
||||||
|
|
||||||
|
`python manage.py addtestdata`
|
||||||
|
|
||||||
|
Creates 10 Companies, with 100 products each.
|
||||||
|
|||||||
Reference in New Issue
Block a user