[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[dak/master] A bit of docs for the ftpmaster api

 dakweb/__init__.py |   41 ++++++++++++++++++++++++++++++++++++++---
 1 file changed, 38 insertions(+), 3 deletions(-)

diff --git a/dakweb/__init__.py b/dakweb/__init__.py
index a6eed9e..c01bfc5 100644
--- a/dakweb/__init__.py
+++ b/dakweb/__init__.py
@@ -1,6 +1,41 @@
-The Debian Archive Kit web api.
+  The Debian Archive Kit web api, AKA the B{FTP-Master api}, allows
+  anyone to query the database of the Debian archive kit for information
+  related to the archive. That is, it provides information about the
+  archive, its suites and all the packages.
-@contact: Debian FTPMaster <ftpmaster@debian.org>
-@license: GNU General Public License version 2 or later
+  Development
+  -----------
+  B{NOTE}: B{The api} is still new and we are adding new features
+  whenever someone asks for them. Or better yet, provides a patch.
+  B{The api}s code lives in the C{dak} codebase, if you want to provide
+  a patch with a new feature, or fix a bug, feel free to clone it::
+   git clone https://ftp-master.debian.org/git/dak.git
+  Patches, Feature requests, bug reports go to the
+  U{debian-dak<mailto:debian-dak@lists.debian.org>}
+  mailing list.
+  B{The api} responds to simple http queries and (usually) replies with
+  JSON formatted data. Some commands may require an extra parameter to
+  output JSON (notably the madison one).
+  U{https://api.ftp-master.debian.org/} is the base path for all
+  requests.
+  Available Methods
+  -----------------
+  The list of available methods can be seen by browsing the
+  automatically generated documentation for the L{dakweb.queries}
+  module. There are various submodules dealing with different parts of
+  the api. Every I{public} function of those modules corresponds to
+  one available method. The input parameters and the output format are
+  documented with each of those functions.
+@contact: "Debian FTPMaster <ftpmaster@debian.org>".

Reply to: