feat: remove tz in api v1, add deprecation notice

This commit is contained in:
spiral 2021-11-30 17:24:50 -05:00
parent cc4e659cec
commit bd166502cc
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
2 changed files with 6 additions and 4 deletions

View File

@ -77,7 +77,9 @@ public static class PKSystemExt
{
case APIVersion.V1:
{
o.Add("tz", null);
// this property was moved to SystemConfig
// see notice in /api/legacy docs
o.Add("tz", "UTC");
o.Add("description_privacy",
ctx == LookupContext.ByOwner ? system.DescriptionPrivacy.ToJsonString() : null);
@ -91,9 +93,6 @@ public static class PKSystemExt
}
case APIVersion.V2:
{
// todo: remove this
o.Add("timezone", null);
if (ctx == LookupContext.ByOwner)
{
// todo: should this be moved to a different JSON model?

View File

@ -6,6 +6,9 @@ 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.
Some keys have been phased out of models and are therefore no longer functioning on v1:
- 2021-12-07: `tz` in system model always returns `UTC` (the default value). the [get system settings](/api/models#get-system-settings) v2 endpoint can be used to get the correct timezone for a system (requires authentication).
:::
## Models