From 2ec796e927f70f240f46fabcf1a6e4f42d581a93 Mon Sep 17 00:00:00 2001 From: lena-larionova Date: Mon, 23 Sep 2024 14:48:51 -0700 Subject: [PATCH] minor cleanup to moved api docs --- app/_src/gateway/production/clustering.md | 63 +------------------ .../hybrid-mode/setup.md | 4 +- 2 files changed, 3 insertions(+), 64 deletions(-) diff --git a/app/_src/gateway/production/clustering.md b/app/_src/gateway/production/clustering.md index 122c6922a62a..3af593bd4f3c 100644 --- a/app/_src/gateway/production/clustering.md +++ b/app/_src/gateway/production/clustering.md @@ -247,68 +247,7 @@ restart will be required to discover any changes to the Cassandra cluster topolo If for some reason, you want to investigate the cached values, or manually invalidate a value cached by Kong (a cached hit or miss), you can do so via the -Admin API `/cache` endpoint. - -{:.note} -> **Note**: Retrieving the `cache_key` for each entity being cached by Kong is -currently an undocumented process. Future versions of the Admin API will make -this process easier. - -### Inspect a cached value - -**Endpoint** - -
/cache/{cache_key}
- -**Response** - -If a value with that key is cached: - -``` -HTTP 200 OK -... -{ - ... -} -``` - -Else: - -``` -HTTP 404 Not Found -``` - -### Purge a cached value - -**Endpoint** - -
/cache/{cache_key}
- -**Response** - -``` -HTTP 204 No Content -... -``` - -### Purge a node's cache - -**Endpoint** - -
/cache
- -**Response** - -``` -HTTP 204 No Content -``` - -{:.note} -> **Note**: Be wary of using this endpoint on a node running in production with warm cache. -If the node is receiving a lot of traffic, purging its cache at the same time -will trigger many requests to your database, and could cause a -[dog-pile effect](https://en.wikipedia.org/wiki/Cache_stampede). - +Admin API [`/cache`](/gateway/api/admin-ee/latest/#/) endpoint. ## Read more diff --git a/app/_src/gateway/production/deployment-topologies/hybrid-mode/setup.md b/app/_src/gateway/production/deployment-topologies/hybrid-mode/setup.md index 3ffc511d5658..3f8b169d311a 100644 --- a/app/_src/gateway/production/deployment-topologies/hybrid-mode/setup.md +++ b/app/_src/gateway/production/deployment-topologies/hybrid-mode/setup.md @@ -593,8 +593,8 @@ and follow the instructions in Steps 1 and 2 **only** to download ## Verify that nodes are connected -Use the control plane’s Cluster Status API to monitor your data planes. It -provides: +Use the control plane’s [Cluster Status API](/gateway/api/admin-ee/latest/#/) to monitor your data planes. +It provides: * The name of the node * The last time the node synced with the control plane * The version of the config currently running on each data plane