From b63698a33205639d172ba28f2c3cd1a15866c28c Mon Sep 17 00:00:00 2001 From: starptech Date: Sun, 25 Apr 2021 19:20:16 +0200 Subject: [PATCH] improve readme --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0efec05..c717d6e 100644 --- a/README.md +++ b/README.md @@ -83,21 +83,6 @@ PUT - `/schema/deactivate` Deactivates a schema by id. The schema will no longer

-POST - `/schema/garbage_collect` Removes all schemas except the most recent N of every service. Returns the removed schemas. This could be called by a [trigger](https://developers.cloudflare.com/workers/platform/cron-triggers). - -
-Example Request -

- -```jsonc -{ - "num_schemas_keep": 10 // minimum is 10 -} -``` - -

-
- ### Validation POST - `/schema/diff` Returns the schema report of all services and the provided new schema. @@ -171,7 +156,22 @@ DELETE - `/persisted_query` Deletes persisted query from KV Storage.

-### Monitoring +### Monitoring / Maintanance + +POST - `/schema/garbage_collect` Removes all schemas except the most recent N of every service. Returns the removed schemas. This could be called by a [trigger](https://developers.cloudflare.com/workers/platform/cron-triggers). + +
+Example Request +

+ +```jsonc +{ + "num_schemas_keep": 10 // minimum is 10 +} +``` + +

+
GET - `/health` healthcheck endpoint.