diff --git a/README.md b/README.md index fde1efa..5cd6c19 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,22 @@ docker-compose exec backend python manage.py migrate Similarly all django commands can be run this way. +## Endpoints + +There are 5 available endpoints: + +1. Empty Response Endpoint - to intentionally get an empty response from the server +2. Directly from BSE - fetchs the data directly from the BSE website +3. Postgres Endpoint - fetches the data from Postgres +4. Redis Cache and Redis Cache v2 - both fetch data from redis, however there is + a slight differece in the way they store data. + - In the 1st case a LIST is stored maintainig the list of stocks for a given + day, and a HASHMAP for every stock is stored + - In the v2 endpoint, the entire JSON response for a day is stringified and + stored + The reason for implemnting two different endpoints, was to just check the + response times. + ## Deploy