feat: remove tz in api v1, add deprecation notice
This commit is contained in:
parent
cc4e659cec
commit
bd166502cc
@ -77,7 +77,9 @@ public static class PKSystemExt
|
|||||||
{
|
{
|
||||||
case APIVersion.V1:
|
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",
|
o.Add("description_privacy",
|
||||||
ctx == LookupContext.ByOwner ? system.DescriptionPrivacy.ToJsonString() : null);
|
ctx == LookupContext.ByOwner ? system.DescriptionPrivacy.ToJsonString() : null);
|
||||||
@ -91,9 +93,6 @@ public static class PKSystemExt
|
|||||||
}
|
}
|
||||||
case APIVersion.V2:
|
case APIVersion.V2:
|
||||||
{
|
{
|
||||||
// todo: remove this
|
|
||||||
o.Add("timezone", null);
|
|
||||||
|
|
||||||
if (ctx == LookupContext.ByOwner)
|
if (ctx == LookupContext.ByOwner)
|
||||||
{
|
{
|
||||||
// todo: should this be moved to a different JSON model?
|
// todo: should this be moved to a different JSON model?
|
||||||
|
@ -6,6 +6,9 @@ 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.
|
||||||
|
|
||||||
|
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
|
## Models
|
||||||
|
Loading…
x
Reference in New Issue
Block a user