1
0
mirror of https://github.com/Decicus/DecAPI-Docs.git synced 2024-11-25 09:52:29 +01:00

[Twitch] Add deprecation notices to the relevant follower endpoints

This commit is contained in:
Alex Thomassen 2023-08-11 23:18:00 +02:00
parent 18adeacc15
commit 41db371031
Signed by: Alex
GPG Key ID: 10BD786B5F6FF5DE

View File

@ -41,6 +41,7 @@ endpoints:
required: false
type: "string"
- route: "followage/:channel/:user"
deprecated: true
parameters:
- name: ":channel"
description: 'The channel name that will be used as reference for checking the "follow age".'
@ -51,6 +52,7 @@ endpoints:
description: 'How precise the timestamp should be in terms of years, months, weeks, days, hours, minutes & seconds.- Default: <code>2</code>.'
type: "int"
notes:
- '<strong>Deprecated</strong>: You can read more here: <a href="https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md">https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md</a>'
- 'Gets the time difference (also known as the "follow age") between when <code>:user</code> followed <code>:channel</code>'
- route: "followcount/:channel"
cached: true
@ -60,6 +62,7 @@ endpoints:
notes:
- 'Retrieves the current amount of followers a Twitch channel has.'
- route: "followed/:channel/:user"
deprecated: true
parameters:
- name: ":channel"
description: 'The channel name.'
@ -73,9 +76,11 @@ endpoints:
description: 'Changes the formatting of the returned date & time. See the <a href="https://www.php.net/manual/en/datetime.format.php#refsect1-datetime.format-parameters"><code>PHP date()</code> documentation</a> for reference.<br>Default format string: <code>M j. Y - h:i:s A (e)</code>'
type: "string"
notes:
- '<strong>Deprecated</strong>: You can read more here: <a href="https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md">https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md</a>'
- 'Retrieves the date and time of when the user followed the channel.'
- 'Example format: <code>Mar 13. 2016 - 07:31:29 PM (UTC)</code>'
- route: "followers/:channel"
deprecated: true
parameters:
- name: ":channel"
description: 'The channel name of the channel you wish to retrieve followers for.'
@ -89,8 +94,10 @@ endpoints:
- name: "separator"
description: "Specify the character(s) used for separating each follower. Default: <kbd>, </kbd>"
notes:
- '<strong>Deprecated</strong>: You can read more here: <a href="https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md">https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md</a>'
- 'Lists the most recent follower(s) a channel has.'
- route: "following/:user"
deprecated: true
parameters:
- name: ":user"
description: 'The username of the user you wanna get the "following" channels from.'
@ -102,6 +109,7 @@ endpoints:
description: 'Specifies the separator used when listing channel names. Default: <code>, </code>.'
type: "string"
notes:
- '<strong>Deprecated</strong>: You can read more here: <a href="https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md">https://gist.github.com/Decicus/daf7234366387636d5d2fe9f59ba0f11#file-2023-08-11_decapi-twitch-follows-endpoints-md</a>'
- 'Retrieves a list of channels that the specified user is following.'
- route: "game/:channel"
cached: true