liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: misc docs stuff

Browse Source
This commit is contained in:
spiral 2021-11-25 17:59:10 -05:00
parent b8e2ebd470
commit 8854063fe9
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
3 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/api/dispatch.md
View File

@ -5,7 +5,7 @@ permalink: /api/dispatch
# Dispatch Webhooks # 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. You will need a publicly-accessible webserver that can receive and process JSON-formatted POST requests.

1
docs/content/api/legacy.md
View File

@ -6,6 +6,7 @@ permalink: /api/legacy
# Legacy API documentation # Legacy API documentation
::: warning ::: warning
This is the documentation for v1 of the PluralKit API. Please use v2 going forwards - v1 is deprecated and will be removed eventually. This is the documentation for v1 of the PluralKit API. Please use v2 going forwards - v1 is deprecated and will be removed eventually.
:::
## Models ## Models
The following three models (usually represented in JSON format) represent the various objects in PluralKit's API. The following three models (usually represented in JSON format) represent the various objects in PluralKit's API.

4
docs/content/api/reference.md
View File

@ -33,9 +33,7 @@ system's token (as described above) will override these privacy settings and sho
## Rate Limiting ## 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 ..... 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.
todo: this isn't implemented yet.
## Community API Libraries ## Community API Libraries