From 13775d1bf07ba9198ad83d673f7bb50e001ea70d Mon Sep 17 00:00:00 2001 From: Kioko Vincent Date: Fri, 15 Nov 2024 13:35:18 +0300 Subject: [PATCH] Update readme for swagger documentation. Not accessing resource --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d9a838a..23eda22 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ Access the server at localhost:800 by default ## SWAGGER DOCUMENTATION All the api endpoints are documented using swagger. Check it on ```{your_endpoint}/documentation/``` To get the deployed swagger docs, check out: -![API Swagger Documentation](https://onlineshopapi-ctyo.onrender.com/documentation/) +[API Swagger Documentation](https://onlineshopapi-ctyo.onrender.com/documentation/) ## TESTS To run tests using coverage ```bash - pip install coverage + pip install coverage pytest coverage run -m pytest coverage report -m ``` @@ -91,8 +91,8 @@ To call resources, add basic token authentication ![Access resources](/Screenshot%202024-11-14%20at%2009.52.52.png) ### Message service -For use of Messaging the customer -Login to Africas talking sandbox site, and get the credentials for the sandbox; When you place an order, a message should appear as below: +For Alerting the customer of the orders +Login to Africa's Talking sandbox, and get the credentials for the sandbox; When you place an order, a message should appear as below: ![AFRICA'S TALKING SCREEN](/Screenshot%202024-11-14%20at%2021.32.33.png) ## API ENDPOINTS