Skip to content

Commit

Permalink
docs: Make the REST API a top level section
Browse files Browse the repository at this point in the history
The page starts to be quite big. The orignal idea was to put both the
XML-RPC and REST APIs on that page, but it seems best for it to have its
own top level section as well.

Signed-off-by: Damien Lespiau <damien.lespiau@intel.com>
  • Loading branch information
Damien Lespiau committed Oct 21, 2015
1 parent a097f01 commit 5dd854f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Contents:
intro
installation
manual
api
rest
development

17 changes: 7 additions & 10 deletions docs/api.rst → docs/rest.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
APIs
===========

REST API
--------
========

API metadata
~~~~~~~~~~~~
------------

.. http:get:: /api/1.0/
Expand All @@ -32,7 +29,7 @@ API metadata


Projects
~~~~~~~~
--------

A project is merely one of the projects defined for this patchwork instance.

Expand Down Expand Up @@ -104,7 +101,7 @@ A project is merely one of the projects defined for this patchwork instance.
}

Events
~~~~~~
------

.. http:get:: /api/1.0/projects/(string: linkname)/events/
.. http:get:: /api/1.0/projects/(int: project_id)/events/
Expand Down Expand Up @@ -155,7 +152,7 @@ At the moment, only one event is listed:
all patches.

Series
~~~~~~
------

A series object represents a lists of patches sent to the mailing-list through
``git-send-email``. It also includes all subsequent patches that are sent to
Expand Down Expand Up @@ -336,7 +333,7 @@ A series has then ``n`` revisions, ``n`` going from ``1`` to ``version``.
}

Patches
~~~~~~~
-------

.. http:get:: /api/1.0/patches/
Expand Down Expand Up @@ -406,7 +403,7 @@ Patches
}

API Revisions
~~~~~~~~~~~~~
-------------

**Revision 1**

Expand Down

0 comments on commit 5dd854f

Please sign in to comment.