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.

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

Api docs enhancements #231

Open
wants to merge 28 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ebd093f
Added description that Provides a brief overview of the API's functio…
mmbogajemimah Mar 18, 2024
89c648a
Added description that Provides a brief overview of the API's functio…
mmbogajemimah Mar 18, 2024
d78246f
Removing trailing slash on Auth APIs
mmbogajemimah Mar 18, 2024
bc48838
Removing trailing slash on Custom Exports APIs
mmbogajemimah Mar 18, 2024
dd678c8
Removing trailing slash on HDX APIs
mmbogajemimah Mar 18, 2024
4a67deb
Removing trailing slash on Raw data APIs
mmbogajemimah Mar 18, 2024
5a1bb3c
Removing trailing slash on statistics for the specified polygon APIs
mmbogajemimah Mar 18, 2024
8954737
Removing trailing slash on tasks APIs
mmbogajemimah Mar 18, 2024
c328827
Removing trailing slash on S3 APIs
mmbogajemimah Mar 18, 2024
b4f59a7
Added description that Provides a brief overview of the API's functio…
mmbogajemimah Mar 18, 2024
0b7ef72
Documenting 403, 404 and 500 Responses on Auth APIs
mmbogajemimah Mar 20, 2024
3bd6f7c
Add changes that when the User is not found in the Database 404 Error…
mmbogajemimah Mar 20, 2024
6f32ae2
A File that contains all responses a user might get while sending a r…
mmbogajemimah Mar 20, 2024
9912908
Updated the Responses using a DRY Approach
mmbogajemimah Mar 20, 2024
fc6a117
Updated Tasks 404, 403, 500 Responses using a DRY Approach
mmbogajemimah Mar 20, 2024
293c87b
Added Docstrings to explain test functions, added exception 403 for a…
mmbogajemimah Mar 26, 2024
1a2f40a
Added docstrings to describe test_app.py test functions
mmbogajemimah Mar 26, 2024
742cac6
Add documentation on how to set env variables in docker and how to ru…
mmbogajemimah Mar 26, 2024
29765a8
How to run Tests in Docker Container
mmbogajemimah Mar 26, 2024
e3b6c81
Added 401 and 500 responses and content
mmbogajemimah Mar 29, 2024
12073ba
Added 401 and 500 responses and content
mmbogajemimah Mar 29, 2024
1de495b
Added 401 and 500 responses and content in routers.py
mmbogajemimah Mar 29, 2024
3d72f98
HDX file in black format
mmbogajemimah Apr 2, 2024
5d50d4b
tasks file in black format
mmbogajemimah Apr 2, 2024
8e3a666
S3 file in black format
mmbogajemimah Apr 2, 2024
556f36e
stats file in black format
mmbogajemimah Apr 2, 2024
2a302fb
routers file in black format
mmbogajemimah Apr 2, 2024
bf222dd
raw_data file in black format
mmbogajemimah Apr 2, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added description that Provides a brief overview of the API's functio…
…nality for documentation purposes
  • Loading branch information
mmbogajemimah committed Mar 18, 2024
commit ebd093f730addea9fb77c620a79aec37d2835b1f
9 changes: 7 additions & 2 deletions API/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,13 @@
import os

os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"

app = FastAPI(title="Raw Data API ", swagger_ui_parameters={"syntaxHighlight": False})
# CHANGES ADDING DESCRIPTION
# Provides a brief overview of the API's functionality for documentation purposes.
app = FastAPI(
title="Raw Data API",
description="This API provides access to raw data.",
swagger_ui_parameters={"syntaxHighlight": False}
)
app.include_router(auth_router)
app.include_router(raw_data_router)
app.include_router(tasks_router)
Expand Down