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

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

Commits on Mar 18, 2024

  1. Added description that Provides a brief overview of the API's functio… 

    …nality for documentation purposes
    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    ebd093f View commit details
    Browse the repository at this point in the history

  2. Added description that Provides a brief overview of the API's functio… 

    …nality for documentation purposes
    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    89c648a View commit details
    Browse the repository at this point in the history

  3. Removing trailing slash on Auth APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    d78246f View commit details
    Browse the repository at this point in the history

  4. Removing trailing slash on Custom Exports APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    bc48838 View commit details
    Browse the repository at this point in the history

  5. Removing trailing slash on HDX APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    dd678c8 View commit details
    Browse the repository at this point in the history

  6. Removing trailing slash on Raw data APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    4a67deb View commit details
    Browse the repository at this point in the history

  7. Removing trailing slash on statistics for the specified polygon APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    5a1bb3c View commit details
    Browse the repository at this point in the history

  8. Removing trailing slash on tasks APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    8954737 View commit details
    Browse the repository at this point in the history

  9. Removing trailing slash on S3 APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    c328827 View commit details
    Browse the repository at this point in the history

  10. Added description that Provides a brief overview of the API's functio… 

    …nality for documentation purposes
    @mmbogajemimah
    mmbogajemimah committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    b4f59a7 View commit details
    Browse the repository at this point in the history

Commits on Mar 20, 2024

  1. Documenting 403, 404 and 500 Responses on Auth APIs

    @mmbogajemimah
    mmbogajemimah committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    0b7ef72 View commit details
    Browse the repository at this point in the history

  2. Add changes that when the User is not found in the Database 404 Error… 

    … is raised
    @mmbogajemimah
    mmbogajemimah committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    3bd6f7c View commit details
    Browse the repository at this point in the history

  3. A File that contains all responses a user might get while sending a r… 

    …equest to the server
    @mmbogajemimah
    mmbogajemimah committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    6f32ae2 View commit details
    Browse the repository at this point in the history

  4. Updated the Responses using a DRY Approach

    @mmbogajemimah
    mmbogajemimah committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    9912908 View commit details
    Browse the repository at this point in the history

  5. Updated Tasks 404, 403, 500 Responses using a DRY Approach

    @mmbogajemimah
    mmbogajemimah committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    fc6a117 View commit details
    Browse the repository at this point in the history

Commits on Mar 26, 2024

  1. Added Docstrings to explain test functions, added exception 403 for a… 

    …uthentication
    @mmbogajemimah
    mmbogajemimah committed Mar 26, 2024
    Configuration menu
    Copy the full SHA
    293c87b View commit details
    Browse the repository at this point in the history

  2. Added docstrings to describe test_app.py test functions

    @mmbogajemimah
    mmbogajemimah committed Mar 26, 2024
    Configuration menu
    Copy the full SHA
    1a2f40a View commit details
    Browse the repository at this point in the history

  3. Add documentation on how to set env variables in docker and how to ru… 

    …n tests in docker
    @mmbogajemimah
    mmbogajemimah committed Mar 26, 2024
    Configuration menu
    Copy the full SHA
    742cac6 View commit details
    Browse the repository at this point in the history

  4. How to run Tests in Docker Container

    @mmbogajemimah
    mmbogajemimah committed Mar 26, 2024
    Configuration menu
    Copy the full SHA
    29765a8 View commit details
    Browse the repository at this point in the history

Commits on Mar 29, 2024

  1. Added 401 and 500 responses and content

    @mmbogajemimah
    mmbogajemimah committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    e3b6c81 View commit details
    Browse the repository at this point in the history

  2. Added 401 and 500 responses and content

    @mmbogajemimah
    mmbogajemimah committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    12073ba View commit details
    Browse the repository at this point in the history

  3. Added 401 and 500 responses and content in routers.py

    @mmbogajemimah
    mmbogajemimah committed Mar 29, 2024
    Configuration menu
    Copy the full SHA
    1de495b View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2024

  1. HDX file in black format

    @mmbogajemimah
    mmbogajemimah committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    3d72f98 View commit details
    Browse the repository at this point in the history

  2. tasks file in black format

    @mmbogajemimah
    mmbogajemimah committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    5d50d4b View commit details
    Browse the repository at this point in the history

  3. S3 file in black format

    @mmbogajemimah
    mmbogajemimah committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    8e3a666 View commit details
    Browse the repository at this point in the history

  4. stats file in black format

    @mmbogajemimah
    mmbogajemimah committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    556f36e View commit details
    Browse the repository at this point in the history

  5. routers file in black format

    @mmbogajemimah
    mmbogajemimah committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    2a302fb View commit details
    Browse the repository at this point in the history

  6. raw_data file in black format

    @mmbogajemimah
    mmbogajemimah committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    bf222dd View commit details
    Browse the repository at this point in the history