fix(docs): update for 6-char IDs

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

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

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

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

View file

@ -46,7 +46,7 @@ You can have a space after `pk;`, e.g. `pk;system` and `pk; system` will do the
:::
## System commands
*To target a specific system, replace `[system]` with that system's 5-character ID, a Discord account ID, or a @mention - note that system names can not be used here. If no system ID is specified, defaults to targeting your own system. For most commands, adding `-clear` will clear/delete the field.*
*To target a specific system, replace `[system]` with that system's 5 or 6 character ID, a Discord account ID, or a @mention - note that system names can not be used here. If no system ID is specified, defaults to targeting your own system. For most commands, adding `-clear` will clear/delete the field.*
- `pk;system [system]` - Shows information about a system.
- `pk;system new [name]` - Creates a new system registered to your account.
- `pk;system [system] rename [new name]` - Changes the name of your system.
@ -74,7 +74,7 @@ You can have a space after `pk;`, e.g. `pk;system` and `pk; system` will do the
- `pk;system [system] id` - Prints a system's id.
## Member commands
*Replace `<member>` with a member's name, 5-character ID or display name. For most commands, adding `-clear` will clear/delete the field.*
*Replace `<member>` with a member's name, 5 or 6 character ID, or display name. For most commands, adding `-clear` will clear/delete the field.*
- `pk;member <member>` - Shows information about a member.
- `pk;member new <name>` - Creates a new system member.
- `pk;member <member> rename <new name>` - Changes the name of a member.
@ -101,7 +101,7 @@ You can have a space after `pk;`, e.g. `pk;system` and `pk; system` will do the
- `pk;member <member> id` - Prints a member's id.
## Group commands
*Replace `<group>` with a group's name, 5-character ID or display name. For most commands, adding `-clear` will clear/delete the field.*
*Replace `<group>` with a group's name, 5 or 6 character ID, or display name. For most commands, adding `-clear` will clear/delete the field.*
- `pk;group <group>` - Shows information about a group.
- `pk;group new <name>` - Creates a new group.
- `pk;group list` - Lists all groups in your system.

View file

@ -17,7 +17,7 @@ An example of a message card is seen below:
![Example of a message query card](../assets/ExampleQuery.png)
### Looking up systems and accounts
Looking up a system by its 5-character ID (`exmpl` in the above screenshot) will show you a list of its linked account IDs. For example:
Looking up a system by its 5 or 6 character ID (`exmpl` in the above screenshot) will show you a list of its linked account IDs. For example:
pk;system exmpl

View file

@ -174,7 +174,7 @@ As the one exception to the rule above, if the name consists of multiple words y
:::
### Looking up member info
To view information about a member, there are a couple ways to do it. Either you can address a member by their name (if they're in your own system), by their 5-character *member ID*, or by their *display name*, like so:
To view information about a member, there are a couple ways to do it. Either you can address a member by their name (if they're in your own system), by their 5 or 6 letter *member ID*, or by their *display name*, like so:
pk;member John
pk;member qazws
@ -481,7 +481,7 @@ Then use the member's proxy tags once to set them as the latched member.
#### Member mode
This autoproxy mode will autoproxy for a specific selected member, irrelevant of past proxies or fronters.
To enable member-mode autoproxying for a given server, use the following command, where `<member>` is a member name (in "quotes" if multiple words) or 5-letter ID:
To enable member-mode autoproxying for a given server, use the following command, where `<member>` is a member name (in "quotes" if multiple words), or 5 or 6 character ID:
pk;autoproxy <member>
@ -614,7 +614,7 @@ To create a new group, use the `pk;group new` command:
pk;group new MyGroup
This will create a new group. Groups all have a 5-letter ID, similar to systems and members.
This will create a new group. Groups all have a 5 or 6 letter ID, similar to systems and members.
### Adding and removing members to groups
To add a member to a group, use the `pk;group <group> add` command, eg: