1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
//! API context: `about`.
//!
//! This API context is responsible for providing metadata about the API.
//!
//! # Endpoints
//!
//! - [About](#about)
//! - [License](#license)
//!
//! # About
//!
//! `GET /v1/about`
//!
//! Returns a html page with information about the API.
//!
//!
//! **Example request**
//!
//! ```bash
//! curl "http://127.0.0.1:3001/v1/about"
//! ```
//!
//! **Example response** `200`
//!
//! ```html
//! <html>
//! <head>
//! <title>About</title>
//! </head>
//! <body style="margin-left: auto; margin-right: auto; max-width: 30em;">
//! <h1>Torrust Index</h1>
//!
//! <h2>About</h2>
//!
//! <p>Hi! This is a running <a href="https://github.com/torrust/torrust-index">torrust-index</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**
//!
//! ```bash
//! curl "http://127.0.0.1:3001/v1/about/license"
//! ```
//!
//! **Example response** `200`
//!
//! ```html
//! <html>
//! <head>
//! <title>Licensing</title>
//! </head>
//! <body style="margin-left: auto; margin-right: auto; max-width: 30em;">
//! <h1>Torrust Index</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/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/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/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>
//! ```