readthedocs.org/readthedocs/restapi
Eric Holscher 4857a90592 Filter project API properly 2014-09-11 10:32:09 -07:00
..
templates/restapi Link footer search to ES frontend now. 2014-08-25 15:08:47 -07:00
views Filter project API properly 2014-09-11 10:32:09 -07:00
README.rst Add REST API README 2014-09-02 12:33:14 -07:00
__init__.py Initial attempt at supporting deprecation of versions. 2013-08-08 14:12:56 -07:00
permissions.py wat 2013-10-27 00:59:18 -07:00
serializers.py Clean up Project apiv2, and add django-filtering. 2014-02-07 21:24:38 +07:00
urls.py Add a CNAME -> slug API endpoint 2014-08-01 21:18:44 -07:00
utils.py Fix location of prod json files 2014-08-07 13:31:42 -07:00

README.rst

API V2
======

This will be the new verison of the Read the Docs API.
The goal will be to enable users a wide range of functionality for interacting with the site via program.

You should be able to use the API to accomplish all tasks within the project admin.
You shoudl be able to create new builds.

Tech
----

We will use Django REST Framework

Auth
----

* Basic Auth
* Token Auth (Oauth)

Tasks
-----

* Manage all Admin-style information via API
	* Settings
	* Versions
	* Maintainers
	* Access Tokens
	* Redirects
	* Translations
	* Subprojects
	* Notifications
* Get Public Project information
	* Active Versions
	* Build Information
	* Downloads
	* Search
* Get User information
	* User activity
* Trigger a new build
* Page-level information
	* Sections
	* Section HTML Content

* Operating Content
	* Footer
	* Version out of date
	* CNAME content
	* Sync versions