diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-10-11 18:14:43 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2016-10-11 18:42:21 +0100 |
| commit | 86397fce246b229b7d215130b2353e49805012a6 (patch) | |
| tree | 4cfdd0e5e271e14a334b7734700e254cc0140ae0 /docs/development | |
| parent | 885e2020abea4c117665420ddce67711e9934176 (diff) | |
| download | patchwork-86397fce246b229b7d215130b2353e49805012a6.tar patchwork-86397fce246b229b7d215130b2353e49805012a6.tar.gz | |
docs: Add basic REST API documentation
This is only user-facing for now. Developer focused docs can be added
later.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/xmlrpc.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/development/xmlrpc.md b/docs/development/xmlrpc.md index 141dec9..1ebc540 100644 --- a/docs/development/xmlrpc.md +++ b/docs/development/xmlrpc.md @@ -1,8 +1,9 @@ # The XML-RPC API **NOTE:** This guide covers development information for the Patchwork XML-RPC -API. For general usage of the API, refer to the [usage -documentation][doc-usage]. +API. For information on using the REST API, refer to the [REST API +documentation][doc-rest]. For information on general usage of the XML-RPC API, +refer to the [user documentation][doc-usage]. Patchwork provides an XML-RPC API. This API can be used to be used to retrieve and modify information about patches, projects and more. @@ -48,5 +49,6 @@ functions (or procedures, in RPC terminology). In the above example, we used the `pw_rpc_version` method, however, it should be possible to use all the methods listed in the [server documentation](#patchwork-api-documentation). +[doc-rest]: ../usage/rest.md [doc-usage]: ../usage/xmlrpc.md [ref-xmlrpclib]: https://docs.python.org/2/library/xmlrpclib.html |