Api docs enhancements

[mmbogajemimah]

What type of Pull Request is this ?

Applicable Checks

• : Documentation
• : Test
• : Bug Fixes
• : Feature
• : Build

Related Issue:

• Resolve Enhance API documentation and examples #219

Consideration

• Added description that Provides a brief overview of the API's functionality for documentation purposes
• Removing trailing slash on Auth, Custom Exports, HDX, Raw Data, stats, tasks and S3 APIs.
• Updated Tasks 404, 403, 500 Responses
• Add changes that when the User is not found in the Database 404 Error is raised
• Added doc-strings to describe test_app.py test functions
• Documentation on How to run Tests in Docker Container
• Added exception 403 for authentication
• Added documentation on how to set env variables in docker and how to run tests in docker
• Added a responses.py file that contains all the errors and error examples to avoid repetition (DRY)

How to Test?

Visit the link below to access the API documentation
Raw Data API Documentation

Rate MyOpenAPI Report:

Raw Data API 1