.. api-wg documentation master file

===========================
OpenStack API Working Group
===========================

.. NOTE::
  THIS DOCUMENT IS CURRENTLY A DRAFT ONLY

This document contains the guidelines and rules for OpenStack project
APIs.

including guidelines and proposed rules concerning API consistency, naming
conventions, and best practice recommendations.

If you are interested in contributing to this document, the git repository is
available at: http://git.openstack.org/cgit/openstack/api-wg/

OpenStack code and review submission processes are described here:
http://docs.openstack.org/infra/manual/developers.html


Guidelines
----------

The following topics have separate doc pages that contain guidance on a
specific issue:

.. toctree::
   :glob:
   :maxdepth: 1

   process
   guidelines/*