update to readme
This commit is contained in:
47
README.md
47
README.md
@@ -39,11 +39,48 @@ To load initial location data use: `python manage.py addgeo`
|
||||
|
||||
## Endpoints
|
||||
|
||||
- `/api/v1/users/`: User information
|
||||
- `/api/v1/companies/`: Company information
|
||||
- `/api/v1/products/`: Product information
|
||||
- `/api/v1/history/`: Historical records about product importation
|
||||
- `/api/v1/stats/`: logs about user interaction with products links
|
||||
|
||||
### Users
|
||||
|
||||
Endpoint url: `/api/v1/users/`
|
||||
|
||||
Authenticated users cannot create new users
|
||||
User are inactive by default
|
||||
|
||||
To create user:
|
||||
```json
|
||||
{
|
||||
"email": "test_user23@mail.com",
|
||||
"full_name": "Mr Test User",
|
||||
"password": "wqertewqr32qrewqr",
|
||||
"provider": "TWITTER"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Companies
|
||||
|
||||
Endpoint url: `/api/v1/companies/`
|
||||
|
||||
### Products
|
||||
|
||||
Endpoint url: `/api/v1/products/`
|
||||
|
||||
|
||||
### History
|
||||
|
||||
Endpoint url: `/api/v1/history/`:
|
||||
|
||||
Historical records about product importation
|
||||
|
||||
|
||||
### Stats
|
||||
Endpoint url: `/api/v1/stats/`
|
||||
|
||||
logs about user interaction with products links
|
||||
|
||||
|
||||
### Geo location
|
||||
|
||||
Location ednpoints:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user