mirror of
https://github.com/Decicus/DecAPI-Docs.git
synced 2024-11-22 08:52:31 +01:00
[DayZ] Document /news endpoint
[Changelog] v2.1.0 Release
This commit is contained in:
parent
f81182cd85
commit
ec8c4da74f
@ -9,6 +9,13 @@ endpoints:
|
||||
notes:
|
||||
- 'Searches for locations based on the search query string, and returns a location name together with a URL to the location on <a href="https://www.izurvive.com/">iZurvive</a>.'
|
||||
- 'This is not always 100% correct. Sorry for any locations that may be incorrect.'
|
||||
- route: "news"
|
||||
parameters:
|
||||
qs:
|
||||
- name : "search"
|
||||
description: "Performs a case insensitive search on the news article <i>title</i>, to filter through them."
|
||||
notes:
|
||||
- 'Returns the latest news article from the <a href="https://dayz.com/">DayZ website</a>.'
|
||||
- route: "players"
|
||||
parameters:
|
||||
qs:
|
||||
@ -30,11 +37,12 @@ endpoints:
|
||||
- route: "status-report"
|
||||
parameters:
|
||||
qs:
|
||||
deprecated: true
|
||||
notes:
|
||||
- 'Retrieves the latest status report from the <a href="https://dayz.com/">DayZ website</a>.'
|
||||
- '<strong>DEPRECATED:</strong> Returns the same as the "news" API endpoint.'
|
||||
- route: "steam-status-report"
|
||||
parameters:
|
||||
qs:
|
||||
deprecated: true
|
||||
notes:
|
||||
- 'As of March 2020, this does exactly the same as <code><a href="/dayz?endpoint=status-report">status-report</a></code>. It is recommended to use that API endpoint instead.'
|
||||
- '<strong>DEPRECATED:</strong> Returns the same as the "news" API endpoint.'
|
||||
|
@ -11,6 +11,56 @@
|
||||
</p>
|
||||
|
||||
<div class="card" id="v2.0.1">
|
||||
<h4 class="card-header bg-primary text-white">
|
||||
Version 2.1.0 - Privacy Policy & Caching
|
||||
|
||||
<span class="badge badge-secondary float-right" title="November 28th, 2020">2020-11-28</span>
|
||||
</h4>
|
||||
|
||||
<div class="card-body">
|
||||
<h5><i class="fab fa-1x fa-fw fa-twitch"></i> Twitch</h5>
|
||||
<ul>
|
||||
<li>
|
||||
The following endpoints are now temporarily cached due to excessive requests from various sources, causing issues with Twitch's rate limits:
|
||||
<ul>
|
||||
<li><code>avatar</code> - 5 minutes per user.</li>
|
||||
<li><code>game</code> - 1 minute per channel.</li>
|
||||
<li><code>status/title</code> - 1 minute per channel.</li>
|
||||
<li><code>subpoints</code> - 2 minutes per channel (used to be 1 minute).</li>
|
||||
<li><code>viewercount</code> - 1 minute per channel.</li>
|
||||
</ul>
|
||||
It's possible that more endpoints will have caching implemented in the future, but we're starting off with these.
|
||||
</li>
|
||||
<li><code>/latest_sub</code>: A minor bug has been fixed where <code>count</code> could be set to anything less than 1 and not return anything. Now it falls back to 1 instead.</li>
|
||||
</ul>
|
||||
|
||||
<h5><i class="fas fa-1x fa-fw fa-gamepad"></i> DayZ</h5>
|
||||
<ul>
|
||||
<li>iZurvive - Map search has been updated to a more recent version of Chernarus.</li>
|
||||
<li>iZurvive - Map search has a slightly different searching algorithm, which may give different results than previously.</li>
|
||||
<li>A <a href="/dayz?endpoint=news">news</a> endpoint has been added, that retrieves the latest news article from the <a href="https://dayz.com/">DayZ website</a>.</li>
|
||||
<li>'Status Report' has been changed to use the 'News' endpoint and is now technically deprecated.</li>
|
||||
</ul>
|
||||
|
||||
<h5><i class="fas fa-1x fa-fw fa-user-secret"></i> Privacy Policy</h5>
|
||||
<ul>
|
||||
<li>A privacy policy has been published under the main website and linked on the homepage: <a href="https://decapi.me/privacy-policy">DecAPI.me/privacy-policy</a>.</li>
|
||||
<li>Privacy policy was long overdue, but nothing has changed with the service itself (in case anyone is concerned about that).</li>
|
||||
<li>If you have any feedback, questions or concerns in regards to the privacy policy, <a href="/contact">please contact me</a> — either via Discord or email.</li>
|
||||
</ul>
|
||||
|
||||
<h5><i class="fas fa-1x fa-fw fa-info"></i> Miscellaneous Other Changes</h5>
|
||||
<ul>
|
||||
<li>The underlying framework, Laravel, has been upgraded from 6.x to 8.x</li>
|
||||
<li>A CLI command for <code>twitch:help</code> (used for updating Twitch help articles) has been removed, as it no longer works.</li>
|
||||
<li>
|
||||
A new configuration option in <code>.env</code> has been added: <code>CACHE_PREFIX</code>. Only really useful for cases where someone is running two separate instances of DecAPI on the same host.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="card mt-4" id="v2.0.1">
|
||||
<h4 class="card-header bg-primary text-white">
|
||||
Version 2.0.1 - Minor changes
|
||||
|
||||
@ -37,7 +87,7 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="card" id="v2.0.0">
|
||||
<div class="card mt-4" id="v2.0.0">
|
||||
<h4 class="card-header bg-primary text-white">
|
||||
Version 2.0.0 - Official Release!
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user