readthedocs.org/readthedocs/restapi
Santos Gallegos e26452a628 Keep compatibility with webhooks 2018-12-04 15:06:26 -05:00
..
templates/restapi Solution 2018-11-01 16:04:03 -05:00
views Keep compatibility with webhooks 2018-12-04 15:06:26 -05:00
README.rst spelling fixes (#2231) 2016-06-02 12:18:14 -07:00
__init__.py Initial attempt at supporting deprecation of versions. 2013-08-08 14:12:56 -07:00
client.py NOQA on import that lint doesn't find 2018-11-19 11:08:18 +01:00
parsers.py Linter 2018-12-03 18:57:19 -05:00
permissions.py Fix D213 using docformatter 2017-12-15 20:18:06 -05:00
serializers.py Merge branch 'master' into remove-unused-project-model-fields 2018-12-04 08:31:25 -05:00
signals.py Finish linting on py3ish code (#2949) 2017-06-14 09:38:03 -07:00
urls.py Upgrade django-rest-framework code to remove warning deprecations 2018-12-04 12:18:46 +01:00
utils.py Typo 2018-11-19 22:04:10 -05:00

README.rst

API V2
======

This will be the new version 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 should 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