Django-rest-framework: Schema & Hypermedia follow ups

Created on 4 Jul 2016  ·  3Comments  ·  Source: encode/django-rest-framework

Placeholder for now to ensure that anything from https://github.com/tomchristie/django-rest-framework/pull/4179 that doesn't make the 3.4.0 cut can be assigned to this ticket.

Currently:

  • [ ] Add descriptions to schema generation, and document use of describe.
  • [x] Supporting id as a keyword argument over pk.
  • [x] Adding type annotations to fields (including in coreapi spec)
  • [x] Handle binary downloads in coreapi library.
  • [ ] Document file uploads and downloads in API clients docs.
  • [ ] Add to quickstart?
  • [ ] Document custom codecs.
Enhancement
Source
picture tomchristie
🎉1

Most helpful comment

Already well underway in the existing 3.5 branch. Will be available later this month.

picture tomchristie on 6 Oct 2016
👍6 😄1

All 3 comments

"Adding type annotations to fields" seems to be the needed feature to make swagger ui display properly the parameters types. When it will be available? Can I help in some way?

robermorales picture robermorales on 6 Oct 2016

Already well underway in the existing 3.5 branch. Will be available later this month.

tomchristie picture tomchristie on 6 Oct 2016
👍6 😄1

Folding remaining points into https://github.com/tomchristie/django-rest-framework/issues/4549 and https://github.com/tomchristie/django-rest-framework/issues/4555

tomchristie picture tomchristie on 11 Oct 2016
Was this page helpful?
0 / 5 - 0 ratings

Related issues

mrodal picture mrodal  ·  3Comments
kdzxiaoli picture kdzxiaoli  ·  3Comments
jpocentek picture jpocentek  ·  3Comments
akhilputhiry picture akhilputhiry  ·  4Comments
rjdp picture rjdp  ·  4Comments