]> git.ipfire.org Git - thirdparty/patchwork.git/commit
docs: Add prototype API specification
authorStephen Finucane <stephen.finucane@intel.com>
Thu, 16 Jun 2016 21:13:16 +0000 (16:13 -0500)
committerStephen Finucane <stephen.finucane@intel.com>
Mon, 27 Jun 2016 17:19:00 +0000 (18:19 +0100)
commit6f283ef361bd58120a527b917a18d4207053f348
treeb42f2ab96a5d87f85b82d1dd897516d048a006f9
parent5b0b0b74d0c32122f8319ee6047c70239417f934
docs: Add prototype API specification

Add specification for a REST API. It documents a number of endpoints
for the following objects/models:

* Projects
* People
* Patches
* Checks

The specification is provided in OpenAPI format [1]. This specification
can be used to automatically generate REST client libraries and to
validate the implemented API.

The API is currently read-only. It is expected that this will expanded
upon as the API grows.

[1] https://openapis.org/specification

Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
Signed-off-by: Andy Doan <andy.doan@linaro.org>
docs/api.yaml [new file with mode: 0644]