mirror of
https://gitlab.com/hagrid-keyserver/hagrid.git
synced 2023-02-13 20:55:02 -05:00
maintenance: add to api documentation
This commit is contained in:
parent
8470d4eb84
commit
8580bb61f6
1 changed files with 28 additions and 2 deletions
30
dist/templates/about/api.html.hbs
vendored
30
dist/templates/about/api.html.hbs
vendored
|
@ -145,12 +145,38 @@
|
|||
"token": "..."
|
||||
}
|
||||
</pre>
|
||||
<div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Error handling</h3>
|
||||
<p>
|
||||
If a request fails for any reason,
|
||||
a suitable HTTP status code will be returned.
|
||||
In this case,
|
||||
the response body will be
|
||||
a JSON object
|
||||
with a single <code>error</code> attribute.
|
||||
A request may fail
|
||||
with an error code of 503
|
||||
at any time
|
||||
if the server is undergoing
|
||||
database maintenance.
|
||||
For this reason,
|
||||
<strong>clients should handle 503 errors gracefully.</strong>
|
||||
</p>
|
||||
|
||||
<div class="example">
|
||||
<div>
|
||||
Example response:
|
||||
<pre>
|
||||
{
|
||||
"error": "We are currently undergoing scheduled database maintenance!",
|
||||
}
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2>HTTP Keyserver Protocol (HKP) Interface</h2>
|
||||
<p>
|
||||
Hagrid implements a subset of
|
||||
|
|
Loading…
Reference in a new issue