From 8854063fe9d5aeeec961ffd4d8986ada0cd527c4 Mon Sep 17 00:00:00 2001 From: spiral Date: Thu, 25 Nov 2021 17:59:10 -0500 Subject: [PATCH] fix: misc docs stuff --- docs/content/api/dispatch.md | 2 +- docs/content/api/legacy.md | 1 + docs/content/api/reference.md | 4 +--- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/content/api/dispatch.md b/docs/content/api/dispatch.md index e3b0b72c..c1299943 100644 --- a/docs/content/api/dispatch.md +++ b/docs/content/api/dispatch.md @@ -5,7 +5,7 @@ permalink: /api/dispatch # Dispatch Webhooks -Dispatch webhooks are a way to get notified when you update your system information on PluralKit. It can be used for integrations where you want to perform some action when you run a bot command on Discord, but also don't want to (or can't) set up a Discord bot to listem to messages. +Dispatch webhooks are a way to get notified when you update your system information on PluralKit. It can be used for integrations where you want to perform some action when you run a bot command on Discord, but also don't want to (or can't) set up a Discord bot to listen to messages. You will need a publicly-accessible webserver that can receive and process JSON-formatted POST requests. diff --git a/docs/content/api/legacy.md b/docs/content/api/legacy.md index eca6dee1..bbd3f3d2 100644 --- a/docs/content/api/legacy.md +++ b/docs/content/api/legacy.md @@ -6,6 +6,7 @@ permalink: /api/legacy # Legacy API documentation ::: warning This is the documentation for v1 of the PluralKit API. Please use v2 going forwards - v1 is deprecated and will be removed eventually. +::: ## Models The following three models (usually represented in JSON format) represent the various objects in PluralKit's API. diff --git a/docs/content/api/reference.md b/docs/content/api/reference.md index 7b01e28e..345ab33f 100644 --- a/docs/content/api/reference.md +++ b/docs/content/api/reference.md @@ -33,9 +33,7 @@ system's token (as described above) will override these privacy settings and sho ## Rate Limiting -By default, there is a per-IP limit of 2 requests per second across the API. If you exceed this limit, you will get a 429 response code with a [rate limit error](#) body ..... - -todo: this isn't implemented yet. +By default, there is a per-IP limit of 2 requests per second across the API. If you exceed this limit, you will get a 429 response code and will have to try again later. ## Community API Libraries