1 """
2 General
3 =======
4 The Debian Archive Kit web api, AKA the **FTP-Master api**, allows
5 anyone to query the database of the Debian archive kit for information
6 related to the archive. That is, it provides information about the
7 archive, its suites and all the packages.
8
9 Development
10 -----------
11
12 .. note::
13
14 The API is still new and we are adding new features
15 whenever someone asks for them. Or better yet, provides a patch.
16 The APIs code lives in the DAK codebase, if you want to provide
17 a patch with a new feature, or fix a bug, feel free to fork it on
18 Salsa and send us a merge request::
19
20 https://salsa.debian.org/ftp-team/dak/
21
22 Usage
23 =====
24 The API responds to simple http queries and (usually) replies with
25 JSON formatted data. Some commands may require an extra parameter to
26 output JSON (notably the madison one).
27
28 ``https://api.ftp-master.debian.org/`` is the base path for all
29 requests.
30
31 Available Methods
32 -----------------
33 The list of available methods can be seen by browsing the
34 automatically generated documentation for the :mod:`dakweb.queries`
35 module. There are various submodules dealing with different parts of
36 the api. Every *public* function of those modules corresponds to
37 one available method. The input parameters and the output format are
38 documented with each of those functions.
39
40
41 @contact: "Debian FTPMaster <ftpmaster@debian.org>".
42 """
43