Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Api docs enhancements #231

Open
wants to merge 28 commits into
base: develop
Choose a base branch
from
Open

Api docs enhancements #231

wants to merge 28 commits into from

Conversation

mmbogajemimah
Copy link

@mmbogajemimah mmbogajemimah commented Mar 19, 2024 •
edited

What type of Pull Request is this ?

Applicable Checks

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

Related Issue:

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

@mmbogajemimah mmbogajemimah mentioned this pull request Mar 19, 2024
Open
@mmbogajemimah
Documenting 403, 404 and 500 Responses on Auth APIs
0b7ef72
@mmbogajemimah
Add changes that when the User is not found in the Database 404 Error…
3bd6f7c 
… is raised
@mmbogajemimah
A File that contains all responses a user might get while sending a r…
6f32ae2 
…equest to the server
@mmbogajemimah
Updated the Responses using a DRY Approach
9912908
@mmbogajemimah
Updated Tasks 404, 403, 500 Responses using a DRY Approach
fc6a117
@mmbogajemimah
Added Docstrings to explain test functions, added exception 403 for a…
293c87b 
…uthentication
@mmbogajemimah
Added docstrings to describe test_app.py test functions
1a2f40a
@mmbogajemimah
Add documentation on how to set env variables in docker and how to ru…
742cac6 
…n tests in docker
@mmbogajemimah
How to run Tests in Docker Container
29765a8
@mmbogajemimah
Added 401 and 500 responses and content
e3b6c81
@mmbogajemimah
Added 401 and 500 responses and content
12073ba
@mmbogajemimah
Added 401 and 500 responses and content in routers.py
1de495b
@mmbogajemimah
HDX file in black format
3d72f98
@mmbogajemimah
tasks file in black format
5d50d4b
@mmbogajemimah
S3 file in black format
8e3a666
@mmbogajemimah
stats file in black format
556f36e
@mmbogajemimah
routers file in black format
2a302fb
@mmbogajemimah
raw_data file in black format
bf222dd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enhance API documentation and examples
1 participant
@mmbogajemimah