predator_pics/views/api.erb

<!--
Copyright (C) 2024 Hexaitos
This file is part of "Predator Pics"

Predator Pics is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Predator Pics is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Foobar. If not, see <https://www.gnu.org/licenses/>.

Contact: me@bateleur.org, me@hexaitos.com. 
-->

<h1>About the API</h1>
<p>There is, at the moment, a <i>very</i> rudimentary API available.</p>
<ul>
    <li>https://birds.bateleur.org/api/random</li>
        <ul>
            <li>Returns a random bird from a random category. Format is JSON and includes: "user", "url", "thumb", "license", "desc", "license_url", "user_url"
        </ul>
    <li>https://birds.bateleur.org/api/categories</li>
        <ul>
            <li>Returns the categories on Wikimedia Commons from which the bot is currently getting its photos. Format is JSON.</li>
        </ul>
</ul>