Add examples in flask - restplus models #27
Merged
Conversation
This file contains hidden or 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
EliuX
reviewed
Mar 17, 2020
time_tracker_api/api.py
Outdated
| title='Creator', | ||
| max_length=64, | ||
| description='User that created it', | ||
| example=faker.uuid4() |
| title='Project', | ||
| max_length=64, | ||
| description='The id of the selected project', | ||
| example=faker.uuid4() |
Contributor
There was a problem hiding this comment.
Actually, the ids that are stored in the database are going to be integers because that is how SQL databases do it. So let's keep the ids as random integers of 4 digits maximum, at least for now. Later when we start doing migrations to uuid we do the change, but the representation has to be truth to real.
| title='Is it running?', | ||
| description='Whether this time entry is currently running or not' | ||
| description='Whether this time entry is currently running or not', | ||
| example=faker.boolean() |
Contributor
There was a problem hiding this comment.
Actually, running has to be true if the end_date has no value. I think that end_date has to have a value or not.
EliuX
approved these changes
Mar 17, 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.
Examples have been added to make the swagger docs more expressive, with the help of the library Faker.
Check #26 for details.
Also I included two fixes in code such as :
uidtoidfor consistency