API Docs improvements #734
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raymondjacobson
commented
Aug 6, 2020
raymondjacobson
force-pushed
the
piazz-docs
branch
from
05229f4
to
02e1efb
Compare
piazzatron
approved these changes
Aug 7, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Trello Card Link
https://trello.com/c/fZlU0a1J/1443-api-docs-formatting-polishing-w-forrest
Description
Adds doc string comments w/ rest+ & cleans up API responses a bit
Services
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide repro instructions & any configuration.
Include log analysis if applicable.
Manually tested each endpoint and viewed swagger documentation. Generated API docs from the changes here.
duration field
Ran a local discovery service, uploaded a track and verified the duration field was present and had the correct value
https/http
Pushed up a custom tag to staging and made sure swagger docs did load
No tracks for non-creator users
Created a user locally and verified
http://localhost:5000/v1/users/7eP5n/tracksreturns