eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-07 22:37:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(docs): update for 6-char IDs

Browse source
This commit is contained in:
Iris System 2024-05-01 20:19:19 +12:00
parent c0b96daa8d
commit 7705bdefab
6 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/content/api/changelog.md
View file

@ -5,6 +5,8 @@ permalink: /api/changelog
# Version history
* 2024-05-01
* Short IDs (the `id` field in system / member / group models) can now be either 5 or 6 characters.
* 2022-12-14
* Added keys to member model: `autoproxy_enabled` (own-system only), `message_count` and `last_message_timestamp` (under metadata privacy)
* 2022-01-11

8
docs/content/api/endpoints.md
View file

@ -12,7 +12,7 @@ All query string parameters are optional, but if present they require a non-null
---
## Systems
*`systemRef` can be a system's short (5-character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.*
*`systemRef` can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.*
### Get System
@ -97,7 +97,7 @@ Currently, only autoproxy with `guild_id` is supported. The API will return an e
---
## Members
*`memberRef` can be a member's short (5-character ID) or a member's UUID.*
*`memberRef` can be a member's short (5 or 6 character ID) or a member's UUID.*
### Get System Members
@ -180,7 +180,7 @@ Returns a [member guild settings](/api/models#member-guild-settings-model) objec
---
## Groups
*`groupRef` can be a group's short (5-character ID) or a group's UUID.*
*`groupRef` can be a group's short (5 or 6 character ID) or a group's UUID.*
### Get System Groups
@ -252,7 +252,7 @@ Takes an array of member references as input. (An empty list is accepted.) Retur
---
## Switches
*`switchRef` must be a switch's UUID. `systemRef` can be a system's short (5-character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.*
*`switchRef` must be a switch's UUID. `systemRef` can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.*
### Get System Switches

2
docs/content/api/models.md
View file

@ -14,7 +14,7 @@ Privacy objects (`privacy` key in models) contain values "private" or "public".
#### Notes on IDs
Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. The short ID is unique across the resource (a member can have the same short ID as a system, for example), while the UUID is consistent for the lifetime of the entity and globally unique across the bot.
Every PluralKit entity has two IDs: a short (5 or 6 character) ID and a longer UUID. The short ID is unique across the resource (a member can have the same short ID as a system, for example), while the UUID is consistent for the lifetime of the entity and globally unique across the bot.
### System model