Browse Source

Update the section about read-write and read-only API keys.

pull/399/head
Pēteris Caune 4 years ago
parent
commit
3f44eac485
No known key found for this signature in database GPG Key ID: E28D7679E9A9EDE2
2 changed files with 4 additions and 2 deletions
  1. +2
    -1
      templates/docs/api.html
  2. +2
    -1
      templates/docs/api.md

+ 2
- 1
templates/docs/api.html View File

@ -64,7 +64,8 @@ and read-only API keys in the <strong>Project Settings</strong> page.</p>
<li><a href="#get-check">Get a single check</a></li>
<li><a href="#list-flips">Get a list of check's status changes</a></li>
</ul>
<p>Omits some fields from the API responses (documented below).</p>
<p>Omits sensitive information from the API responses. See the documentation of
individual API endpoints for details.</p>
</dd>
</dl>
<p>The client can authenticate itself by including an <code>X-Api-Key: &lt;your-api-key&gt;</code>


+ 2
- 1
templates/docs/api.md View File

@ -34,7 +34,8 @@ read-only key
* [Get a single check](#get-check)
* [Get a list of check's status changes](#list-flips)
Omits some fields from the API responses (documented below).
Omits sensitive information from the API responses. See the documentation of
individual API endpoints for details.
The client can authenticate itself by including an `X-Api-Key: <your-api-key>`
header in a HTTP request. Alternatively, for POST requests with a JSON request body,


Loading…
Cancel
Save