The fields parameter doesn't appear in API docs

wimglenn / djangorestframework-queryfields

Allows clients to control which fields will be sent in the API response

http://djangorestframework-queryfields.readthedocs.io/

MIT License

216 stars 16 forks source link

The fields parameter doesn't appear in API docs #25

Open daviddavis opened 5 years ago

daviddavis commented 5 years ago

The fields and fields! parameters don't appear in DRF's autogenerated api docs. It'd be nice to have code and/or docs on how to add these parameters in djangorestframework-queryfields.

zomglings commented 4 years ago

@wimglenn : Are you accepting PRs on this repo? I plan to work on this since I'm using your library and also need to have an OpenAPI schema that correctly reflects the query parameter.

Without having done too much research, I assume I can replicate django-filter's strategy: https://django-filter.readthedocs.io/en/master/guide/rest_framework.html#schema-generation-with-core-api-and-open-api

Let me know.

wimglenn commented 4 years ago

Yes, I am accepting PRs. The auto-generated docs stuff seems like a useful addition, just make sure to add test coverage for any new code.