Skip to content

Ship API v3 #6169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Oct 30, 2019
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
b65098c
Ship API v3
humitos Sep 11, 2019
79f7740
Allow users to generate/revoke API Tokens
humitos Sep 11, 2019
6d8b6cd
Test cases for list/create/delete API Tokens
humitos Sep 11, 2019
2163fed
Lint
humitos Sep 12, 2019
4d65213
Update readthedocs/profiles/views.py
humitos Sep 12, 2019
630cf84
Use one step deletion to revoke the token
humitos Sep 12, 2019
f7e168f
Remove redundant documentation and make it cleaner
humitos Oct 1, 2019
1bb3742
Mention where to find the token in the root API URL
humitos Oct 1, 2019
5ab0c5e
Add a tip mentioning that it's possible to browse the API
humitos Oct 1, 2019
9678048
Remove Project docstring (shown in browseable API resource)
humitos Oct 1, 2019
192fe2f
Remove unuseful (Project, Version) filters
humitos Oct 1, 2019
5fe990c
Remove half-baked docs from the Browsable API and make it consistent
humitos Oct 1, 2019
67ac5e5
Build trigger response docs
humitos Oct 1, 2019
8e59cf5
Better docs for version update
humitos Oct 1, 2019
e6f711d
Fix same page link
humitos Oct 1, 2019
536d0a2
Merge branch 'master' of github.com:readthedocs/readthedocs.org into …
humitos Oct 8, 2019
995287f
Remove duplicated references docs
humitos Oct 8, 2019
a888bc8
Remove privacy_level field from APIv3
humitos Oct 8, 2019
8c3caf8
Update docs for different Redirect types
humitos Oct 9, 2019
03f2d29
Add more redirect creation via APIv3 tests
humitos Oct 9, 2019
ffab3b2
Merge branch 'master' of github.com:readthedocs/readthedocs.org into …
humitos Oct 9, 2019
06d31f6
Merge branch 'master' of github.com:readthedocs/readthedocs.org into …
humitos Oct 9, 2019
558e143
Merge branch 'humitos/ship-api-v3' of github.com:readthedocs/readthed…
humitos Oct 9, 2019
9eb8df8
Remove privacy_level field from APIv3 (#6257)
humitos Oct 9, 2019
e3e5d73
Valid status codes for privacy URL tests
humitos Oct 14, 2019
7aa32ca
Update APIv3 design document
humitos Oct 14, 2019
9bb7cb2
Apply suggestions from code review
humitos Oct 22, 2019
6b88986
Re-add "Subproject details" section in docs
humitos Oct 22, 2019
5a398d4
Merge branch 'master' of github.com:readthedocs/readthedocs.org into …
humitos Oct 22, 2019
afcfbf7
Merge branch 'humitos/ship-api-v3' of github.com:readthedocs/readthed…
humitos Oct 22, 2019
b7adaf6
Fix tests introduced in merge conflict
humitos Oct 22, 2019
4c40669
Ignore linting in a method override
humitos Oct 28, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ from Read the Docs.
:maxdepth: 3

v2
v3
16 changes: 8 additions & 8 deletions docs/api/v2.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
API v2
======
API v2 (deprecated)
===================

The Read the Docs API uses :abbr:`REST (Representational State Transfer)`.
JSON is returned by all API responses including errors
and HTTP response status codes are to designate success and failure.

.. note::

A newer API v3 is in early development stages.
A newer and better API v3 is ready to use.
Some improvements coming in v3 are:

* Search API
* Write access
* Simpler URLs which use slugs instead of numeric IDs
* Simpler URLs which use slugs
* Token based authentication
* Import a new project
* Activate a version
* Improved error reporting

If there are features you would like in v3, please get in touch
in the `issue tracker <https://github.com/readthedocs/readthedocs.org/issues>`_.
See its full documentation at :doc:`/api/v3`.


Authentication and authorization
Expand Down
Loading