Skip to content

Commit

Permalink
docs: Add patch and series mbox entry points
Browse files Browse the repository at this point in the history
I didn't bump the API revision just yet, let's batch up a few more
changes before doing so.

Signed-off-by: Damien Lespiau <damien.lespiau@intel.com>
  • Loading branch information
Damien Lespiau committed Oct 23, 2015
1 parent cf21a34 commit c8c0cd0
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/rest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,17 @@ A series has then ``n`` revisions, ``n`` going from ``1`` to ``version``.
]
}

.. http:get:: /api/1.0/series/(int: series_id)/revisions/(int: version)/mbox/
Retrieve an mbox file that will contain all patches of this revision, in
order in which to apply them. This mbox file can be directly piped into
``git am``.

::

$ curl -s http://patchwork.freedesktop.org/api/1.0/series/42/revisions/2/mbox/ | git am -3


Patches
-------

Expand Down Expand Up @@ -402,9 +413,23 @@ Patches
"content": "<diff content>"
}

.. http:get:: /api/1.0/patches/(int: patch_id)/mbox/
Retrieve an mbox file. This mbox file can be directly piped into ``git am``.

::

$ curl -s http://patchwork.freedesktop.org/api/1.0/patches/42/mbox/ | git am -3

API Revisions
-------------

**Revision 2**

- Add mbox entry points for both patches and seriesL
- /patches/${id}/mbox/
- /series/${id}/revisions/${version}/mbox/

**Revision 1**

- Add /projects/${linkname}/events/ entry point.
Expand Down

0 comments on commit c8c0cd0

Please sign in to comment.