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.

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 documentation showing as integer instead of object in the response #83

Open
rathorevaibhav opened this issue Apr 5, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@rathorevaibhav
Copy link
Contributor

rathorevaibhav commented Apr 5, 2021

Describe the task
In the redoc API documentation that is accessible at host:port/ap1/v1/docs, the foreign key fields are displayed as integers. However, in actual response, that field comes as an object.

API documentation
image

Expected behavior

  1. The API documentation should show the foreign key references as objects and document their attributes as well in the response format.
  2. Check for all the foreign keys in every endpoint where we're returning foreign references as objects.
@rathorevaibhav rathorevaibhav added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 5, 2021
@rathorevaibhav rathorevaibhav added this to the v0.1 milestone Apr 5, 2021
@dalmia dalmia removed this from the v0.1 milestone Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants