doc/api/reference/clientconfig.rst

   1 Client Parametrization
   2 ======================
   3
   4 The client configuration file is located at
   5 http://gpodder.net/clientconfig.json and contains information that clients
   6 should retrieve before making requests to the APIs.
   7
   8 If a client cannot retrieve and process this file (either temporarily or
   9 permanently), it can assume the default values provided below. However,
  10 the URLs in the file might reflect changed URLs and/or mirror servers. If a
  11 client decides to permanently ignore this file, it might hit an outdated URL
  12 or an overloaded server.
  13
  14
  15 Commented Example
  16 -----------------
  17
  18 .. code-block:: json
  19
  20     {
  21         "mygpo":  {
  22             "baseurl": "http://gpodder.net/"
  23         }
  24
  25         "mygpo-feedservice": {
  26             "baseurl": "http://mygpo-feedservice.appspot.com/"
  27         }
  28
  29         "update_timeout": 604800,
  30     }
  31
  32 * ``mygpo/baseurl``: URL to which the gpodder.net API Endpoints should be appended
  33 * ``mygpo-feedservice/baseurl``: Base URL of the gpodder.net feed service
  34 * ``update_timeout``: Time in seconds for which the values in this file can be considered valid.