openstack/cinder
Code Issues Proposed changes
66b3a52794
cinder/doc/source/contributor/api.rst
Jay S. Bryant 1423480fb6 Make doc/source directory compliant with design in spec 
The following spec defines what each project's doc/source
directory is supposed to look like:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory.  It also moves the CLI
related documentation into the 'cli' directory.  I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.

This patch also creates a template for future documentation
contribution.  I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.

The index file is updated to point at the new locations for
existing content.

'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.

Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
2017-07-19 15:59:02 -05:00

2.2 KiB
Raw Blame History

API Endpoint

Cinder has a system for managing multiple APIs on different subdomains. Currently there is support for the OpenStack API.

Common Components

The cinder.api Module

cinder.api

Tests

The api Module

cinder.tests.unit.api

The api.fakes Module

cinder.tests.unit.api.fakes

The api.openstack Module

cinder.tests.unit.api.openstack

The api.openstack.test_wsgi Module

cinder.tests.unit.api.openstack.test_wsgi

The test_auth Module

cinder.tests.unit.api.middleware.test_auth

The test_faults Module

cinder.tests.unit.api.middleware.test_faults