From ca89ac73f23abfac8dddf34b426f77a58e916d1e Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 1 Feb 2021 13:36:42 +0000 Subject: [PATCH] update to readme --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3ef1321..d3976f0 100644 --- a/README.md +++ b/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: