1357476 - Replace django-rest-swagger with djangorestframework's native interactive docs

Status: RESOLVED FIXED

(Tree Management :: Treeherder: API, defect, P1)

Description

[Ed Morley [:emorley]]

d-r-f 3.6 added a new native docs feature:
http://www.django-rest-framework.org/topics/3.6-announcement/
http://www.django-rest-framework.org/topics/documenting-your-api/

This needs setting up (adding to urls.py etc) however may be sufficient to replace Django rest swagger entirely.

Comment 2

[Ed Morley [:emorley]]

It turns out this reduces the time taken to run `collectstatic` by 70% (due to the reduction in staticfiles and how long Brotli compression takes), which will help with our deploy times.

Comment 3

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3230

Comment 4

[Treeherder GitHub Bugbot]

Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/0aec43a139888e86e44cc11e4e667f19c28881ad
Bug 1357476 - Replace django-rest-swagger with native d-r-f docs (#3230)

Now that django-rest-framework supports interactive docs natively,
we no longer need to use the additional django-rest-swagger package:
http://www.django-rest-framework.org/topics/3.6-announcement/#interactive-api-documentation
http://www.django-rest-framework.org/topics/documenting-your-api/

This significantly reduces the number of static files that have to
be processed, reducing the time taken for `collectstatic` (which is
run on every deployment and takes a while due to Brotli compression)
by 70%.

Comment 5

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3390

Comment 6

[Treeherder GitHub Bugbot]

Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/3d50e32d4da798029dab06ddceb3bc75f2d4920e
Bug 1357476 - Remove django-rest-swagger remnants (#3390)

These are leftover from 0aec43a (#3230).