.. vnc_api documentation master file, created by
   sphinx-quickstart on Sun Mar 10 23:39:27 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Juniper Contrail Configuration API server documentation
=======================================================

The Juniper Contrail configuration API server allows for manipulation of configuration
elements exposed by the VNS. Interaction with this server is possible through either a REST interface
or by a python library (which internally uses the same REST API). 

This document provides
   * Tutorials for using the REST and library interface,
   * Generalizes the examples to work on different configuration elements
   * Provides tips to use the system effectively
   * Reference of the package, module and classes involved.

.. toctree::
   :maxdepth: 5

   tutorial_with_rest.rst
   tutorial_with_library.rst
   rest_details.rst
   library_details.rst
   rest_reference.rst
   library_reference.rst
   .. modules.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`