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

Document Content-Type requirement for API

Browse Source
This commit is contained in:
Ske 2020-02-03 14:47:08 +01:00
parent a7e071eb24
commit ab39ebc512
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/3-api-documentation.md
View File

@ -13,6 +13,8 @@ Endpoints will always return all fields, using `null` when a value is missing. O
missing fields from the JSON request will be ignored and preserved as is, but on `POST` endpoints will missing fields from the JSON request will be ignored and preserved as is, but on `POST` endpoints will
be set to `null` or cleared. be set to `null` or cleared.
Endpoints taking JSON bodies (eg. most `PATCH` and `PUT` endpoints) require the `Content-Type: application/json` header set.
## Authentication ## Authentication
Authentication is done with a simple "system token". You can get your system token by running `pk;token` using the Authentication is done with a simple "system token". You can get your system token by running `pk;token` using the
Discord bot, either in a channel with the bot or in DMs. Then, pass this token in the `Authorization` HTTP header Discord bot, either in a channel with the bot or in DMs. Then, pass this token in the `Authorization` HTTP header