docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. _master_index:
   3
   4 AAI Documentation Repository
   5 ----------------------------
   6 Active and Available Inventory (AAI) is the "one-stop-shop" where all the network information comes together.  Modern networks are complex, dynamic, and difficult to manage, and AAI delivers live insight into hybrid services and virtual resources, in support of closed loop processes.  We hold the references to the network services and infrastructure, data center resources, connectivity components, and service overlays; and we know how they're all related.
   7
   8 The key AAI repos for running the AAI REST APIs:
   9
  10 - aai/aai-common: This holds the model, annotations and common modules used across the Resources and Traversal micro services
  11 - aai/traversal: AAI Traversal Micro Service providing REST APIs for traversal/search of inventory resources
  12 - aai/resources: AAI Resources Micro Service providing CRUD REST APIs for inventory resources
  13
  14 .. toctree::
  15    :maxdepth: 2
  16
  17    platform/index.rst
  18    release-notes.rst
  19    AAI REST API Documentation/AAIRESTAPI.rst
  20    AAI REST API Documentation/bulkApi.rst
  21    AAI REST API Documentation/customQueries.rst
  22    AAI REST API Documentation/genericQueries.rst
  23    AAI REST API Documentation/nodesApi.rst
  24    AAI REST API Documentation/nodesQuery.rst
  25    AAI REST API Documentation/recentsApi.rst