walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2016-06-05 13:17:48 +09:00
parent c3817913ee
commit 4ef3f9d11c
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/nghttpx.h2r
View File

@ -471,6 +471,26 @@ frontend for API using :option:`--frontend` option with "api"
parameter. All requests which come from this frontend address, will parameter. All requests which come from this frontend address, will
be treated as API request. be treated as API request.
The response is normally JSON dictionary, and at least includes the
following keys:
status
The status of the request processing. The following values are
defined:
Success
The request was successful.
Failure
The request was faield. No change has been made.
code
HTTP status code
We wrote "normally", since nghttpx may return ordinal HTML response in
some cases where the error has occurred before reaching API endpoint
(e.g., header field is too large).
The following section describes available API endpoints. The following section describes available API endpoints.
PUT /api/v1beta1/backend/replace PUT /api/v1beta1/backend/replace