Coverage for dakweb/__init__.py: 100%

1""" 

2General 

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 

22Usage 

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 api is implemented with FastAPI, which serves interactive, 

34 automatically generated documentation describing every available 

35 method, its input parameters and its output format. Browse it at the 

36 ``/docs`` (Swagger UI) or ``/redoc`` paths of a running instance. The 

37 routes live in the :mod:`dakweb.routers` module. 

38 

39 

40@contact: "Debian FTPMaster <ftpmaster@debian.org>". 

41"""