Expand description
API context: about.
This API context is responsible for providing metadata about the API.
§Endpoints
§About
GET /v1/about
Returns a html page with information about the API.
Example request
curl "http://127.0.0.1:3001/v1/about"Example response 200
<html>
<head>
<title>About</title>
</head>
<body style="margin-left: auto; margin-right: auto; max-width: 30em;">
<h1>Torrust Index Backend</h1>
<h2>About</h2>
<p>Hi! This is a running <a href="https://github.com/torrust/torrust-index-backend">torrust-index-backend</a>.</p>
</body>
<footer style="padding: 1.25em 0; border-top: dotted 1px;">
<a href="/v1/about/license">license</a>
</footer>
</html>§License
GET /v1/about/license
Returns the API license.
Example request
curl "http://127.0.0.1:3001/v1/about/license"Example response 200
<html>
<head>
<title>Licensing</title>
</head>
<body style="margin-left: auto; margin-right: auto; max-width: 30em;">
<h1>Torrust Index Backend</h1>
<h2>Licensing</h2>
<h3>Multiple Licenses</h3>
<p>
This repository has multiple licenses depending on the content type, the date of contributions or stemming from external component licenses that were not developed by any of Torrust team members or Torrust repository
contributors.
</p>
<p>The two main applicable license to most of its content are:</p>
<p>- For Code -- <a href="https://github.com/torrust/torrust-index-backend/blob/main/licensing/agpl-3.0.md">agpl-3.0</a></p>
<p>- For Media (Images, etc.) -- <a href="https://github.com/torrust/torrust-index-backend/blob/main/licensing/cc-by-sa.md">cc-by-sa</a></p>
<p>If you want to read more about all the licenses and how they apply please refer to the <a href="https://github.com/torrust/torrust-index-backend/blob/develop/licensing/contributor_agreement_v01.md">contributor agreement</a>.</p>
</body>
<footer style="padding: 1.25em 0; border-top: dotted 1px;">
<a href="/v1/about">about</a>
</footer>
</html>