Add test to ensure documentation for API

[rickyrombo]

Description

Adds a test to ensure once we have proper documentation for our API that we don't forget to keep it that way.

• Checks for descriptions of each request endpoint
• Checks for summary if description is too long
• Checks for duplicate operation IDs (this is the important one - messes up typegen)
• Checks that every parameter has a description

Groups the output by endpoint for easier reading/addressing. Currently passes because I've commented out the assert (since things are not yet in a good state).

Default API test output:

src/api/v1/api_unit_test.py::test_validate_v1_swagger 

Found 18 errors in Swagger schema

/challenges/attest_sender:
----------------------------------------------
GET Missing endpoint description annotation

/challenges/undisbursed:
----------------------------------------------
GET Missing endpoint description annotation

/challenges/{challenge_id}/attest:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "challenge_id"
GET Missing endpoint description annotation
GET Missing parameter description annotation for "oracle"
GET Missing parameter description annotation for "specifier"
GET Missing parameter description annotation for "user_id"

/metrics/app_name/trailing/{time_range}:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "time_range"
GET Missing endpoint description annotation

/playlists/search:
----------------------------------------------
GET Missing endpoint description annotation

/playlists/trending:
----------------------------------------------
GET Duplicate operation ID "Trending Playlists"
GET Missing endpoint description annotation

/playlists/trending/{version}:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "version"
GET Duplicate operation ID "Trending Playlists"
GET Missing endpoint description annotation

/playlists/{playlist_id}:
----------------------------------------------
GET Missing endpoint description annotation

/playlists/{playlist_id}/tracks:
----------------------------------------------
GET Missing endpoint description annotation

/users/search:
----------------------------------------------
GET Missing endpoint description annotation

PASSED

Full API test output:

src/api/v1/api_unit_test.py::test_validate_v1_full_swagger 

Found 26 errors in Swagger schema

/playlists/trending:
----------------------------------------------
GET Duplicate operation ID "Returns trending playlists for a time period based on the given trending version"
GET Missing endpoint description annotation

/playlists/trending/{version}:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "version"
GET Duplicate operation ID "Returns trending playlists for a time period based on the given trending version"
GET Missing endpoint description annotation

/playlists/{playlist_id}:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "playlist_id"
GET Missing endpoint description annotation

/playlists/{playlist_id}/favorites:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "playlist_id"
GET Missing endpoint description annotation

/playlists/{playlist_id}/reposts:
----------------------------------------------
PARAMETERS Missing parameter description annotation for "playlist_id"
GET Missing endpoint description annotation

/search/autocomplete:
----------------------------------------------
GET Missing endpoint description annotation

/search/full:
----------------------------------------------
GET Missing endpoint description annotation

/tracks/best_new_releases:
----------------------------------------------
GET Missing endpoint description annotation

/tracks/by_ids:
----------------------------------------------
GET Missing endpoint description annotation

/tracks/most_loved:
----------------------------------------------
GET Missing parameter description annotation for "limit"
GET Missing parameter description annotation for "user_id"
GET Missing parameter description annotation for "with_users"

/tracks/under_the_radar:
----------------------------------------------
GET Missing endpoint description annotation
GET Missing parameter description annotation for "filter"
GET Missing parameter description annotation for "limit"
GET Missing parameter description annotation for "offset"
GET Missing parameter description annotation for "tracks_only"
GET Missing parameter description annotation for "user_id"
GET Missing parameter description annotation for "with_users"

/users/{id}/history/tracks:
----------------------------------------------
GET Missing endpoint description annotation

PASSED