90060722a9
This patch introduces a new directory layout in doc/source in conformance with the OpenStack manuals project migration spec [1], moves the existing content in manila/doc/source into the new directories, and adjusts index files accordingly. This is the first step in the migration process as outlined in the spec. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Partial-Bug: #1706181 Needed-By: I7924d94b82e7c8d9716bad7a219fc38c57970773 Depends-On: Ifc80fc56648cef74c85464321d1850e8c68449a0 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: Ieea33262101a1d2459492c1c8aaac5fe042279f6
77 lines
1.8 KiB
ReStructuredText
77 lines
1.8 KiB
ReStructuredText
..
|
|
Copyright 2010-2011 United States Government as represented by the
|
|
Administrator of the National Aeronautics and Space Administration.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
API Endpoint
|
|
============
|
|
|
|
Manila has a system for managing multiple APIs on different subdomains.
|
|
Currently there is support for the OpenStack API.
|
|
|
|
Common Components
|
|
-----------------
|
|
|
|
The :mod:`manila.api` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. automodule:: manila.api
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|
|
The :mod:`manila.api.v1` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. automodule:: manila.api
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|
|
The :mod:`manila.api.contrib` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. automodule:: manila.api
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|
|
OpenStack API
|
|
-------------
|
|
|
|
The :mod:`openstack` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. automodule:: manila.api.openstack
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|
|
Tests
|
|
-----
|
|
|
|
The :mod:`api` Module
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. automodule:: manila.tests.api
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|