]> git.ipfire.org Git - thirdparty/patchwork.git/commit
docs: Start documenting API using OpenAPI
authorStephen Finucane <stephen@that.guru>
Fri, 26 Oct 2018 20:42:02 +0000 (21:42 +0100)
committerStephen Finucane <stephen@that.guru>
Sat, 22 Dec 2018 17:19:06 +0000 (17:19 +0000)
commit7d8e24bc84bd0c73643822944b3c7dc901ee8b41
tree8ddde7df4de05b8b9435506282edbdb97098b421
parentdc48fbce99efe7d13987a3f510f7dee389636eba
docs: Start documenting API using OpenAPI

When the REST API was first added, we attempted to document it using
OpenAPI 2.0 (formerly Swagger). This was mostly never completed because
(a) it was really tedious and (b) no one was that bothered. However, as
we expand the range of clients for the REST API, having a well
documented API becomes more and more of an asset.

Start doing this by adding a brand new schema, this time using OpenAPI.
This will entirely replace the older schema and, as such, is namespaced
separately. We start by documenting '/' (i.e. the index) page and will
add additional resources as we go.

Signed-off-by: Stephen Finucane <stephen@that.guru>
docs/api/schemas/patchwork.yaml [new file with mode: 0644]