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

Jump to bottom

Missing "timer" field documentation in openapi schema #439

Closed
xiiran opened this issue Apr 13, 2022 · 1 comment · Fixed by #474
Closed

Missing "timer" field documentation in openapi schema #439

xiiran opened this issue Apr 13, 2022 · 1 comment · Fixed by #474
Labels
documentation Issues relating to documentation good first issue Good candidates for simple work for first time contributors

Comments

@xiiran
Copy link

xiiran commented Apr 13, 2022

Hello,

I noticed that the documentation of the 'timer' field which was introduced here d6cb6dc is missing in the openapi schema file.
@cdubz
Copy link
Member

cdubz commented Apr 13, 2022

Nice catch. The file is generated by DRF's generateschema command documented here: https://www.django-rest-framework.org/api-guide/schemas/

I'm guessing we'd need to customize the schema data to add information about the timer attribute. Not totally sure though.

@cdubz cdubz added help wanted Issues where maintainers could use assistance from others good first issue Good candidates for simple work for first time contributors documentation Issues relating to documentation labels Apr 13, 2022
@cdubz cdubz mentioned this issue Jun 5, 2022
Merged
@cdubz cdubz removed the help wanted Issues where maintainers could use assistance from others label Jun 5, 2022
@cdubz cdubz closed this as completed in #474 Jun 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Issues relating to documentation good first issue Good candidates for simple work for first time contributors
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add timer field data to OpenAPI schema babybuddy/babybuddy
2 participants
@cdubz @xiiran