From 3f44eac4856e2c7f6a56c1bf2f477080657c7399 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C4=93teris=20Caune?= Date: Wed, 8 Jul 2020 13:55:46 +0300 Subject: [PATCH] Update the section about read-write and read-only API keys. --- templates/docs/api.html | 3 ++- templates/docs/api.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/templates/docs/api.html b/templates/docs/api.html index f266380b..648b7b71 100644 --- a/templates/docs/api.html +++ b/templates/docs/api.html @@ -64,7 +64,8 @@ and read-only API keys in the Project Settings page.

  • Get a single check
  • Get a list of check's status changes
  • -

    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> diff --git a/templates/docs/api.md b/templates/docs/api.md index 645e048f..316f9a62 100644 --- a/templates/docs/api.md +++ b/templates/docs/api.md @@ -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: ` header in a HTTP request. Alternatively, for POST requests with a JSON request body,