Commit Graph

6 Commits

Author SHA1 Message Date
Sebastiaan van Stijn 32958e7c60 Improve Engine API documentation (#5607)
* Share redoc JavaScript between API versions

The redoc JavaScript is a big file, and there's no need
to keep a separate copy for each version of the API.

This patch removes the copy per-version and moves the script
to a central location.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Use central stylesheet for API reference

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Update ReDoc to v1.19.3

Changelog can be found at https://github.com/Rebilly/ReDoc/blob/v1.19.3/CHANGELOG.md

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Hide "request type" badges in menu

ReDoc 1.13 added "request type" badges in the menu
given that we didn't show these before, this patch
hides them.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Add .map file for ReDoc

Having a .map file allows debugging script issues
in the ReDoc JavaScript (which is minified).

It's a big file, but may be useful to have.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-12-26 12:35:10 -08:00
Roman Hotsiy c6c3476c6c Upgrade to ReDoc 1.11.0, closes #2246 (#2249) 2017-03-10 11:53:37 -08:00
Misty Stanley-Jones c525c9b1a8 Merge pull request #210 from bfirsh/api-and-sdks-documentation
Better API and SDKs documentation
2017-01-19 10:51:53 -08:00
Ben Firshman c3ec389a72 Add full documentation for APIs and SDKs
Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2017-01-19 10:51:52 -08:00
Ben Firshman 1d5c338ee0 Upgrade to ReDoc 1.6.2 (#891)
To make use of x-displayName added in
https://github.com/docker/docker/pull/29401

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2017-01-19 10:45:11 -08:00
Ben Firshman f8dac1b53c Add automatically generated Engine API docs
Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2017-01-19 10:45:07 -08:00