doc/api/index.rst

   1 .. gpodder.net documentation master file, created by
   2    sphinx-quickstart on Sat Mar  9 11:41:24 2013.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 API Documentation
   7 =================
   8
   9 This is the specification of Version 2 of the public API for the gpodder.net
  10 Web Services.
  11
  12 Please consult the :doc:`integration` before integrating the gpodder.net API
  13 in your application.
  14
  15 There are two different APIs for different target audiences:
  16
  17 * The **Simple API** targets developers who want to write quick integration
  18   into their existing applications
  19 * The **Advanced API** targets developers who want tight integration into their
  20   applications (with more features)
  21
  22 The API is versioned so that changes in the major version number indicate
  23 backwards incompatible changes. All other changes preserve backwards
  24 compatibility. See :doc:`changes` for a list of changes. The current
  25 version is 2.11. This versioning scheme has been introduced in `bug 1273
  26 <https://bugs.gpodder.org/show_bug.cgi?id=1273>`_.
  27
  28 The API is available as a machine-readable file in OpenAPI format at
  29 https://raw.githubusercontent.com/gpodder/mygpo/master/mygpo/api/openapi.yaml
  30
  31 Contents
  32 --------
  33
  34 .. toctree::
  35    :maxdepth: 2
  36
  37    integration
  38    reference/index
  39    Libraries <https://gpoddernet.readthedocs.io/en/latest/dev/libraries.html>
  40    api1
  41    api3
  42    changes