Doug Hellmann
c16cd04cf6
blueprint sphinx-doc-cleanup bug 944385 - Fix formatting and markup issues that produce error messages - Update TOC lists for missing/new files - Fix a few links - Update instructions with dependencies for building the documentation - Updated base on review comments from oubiwann to fix trailing whitespace in modified files Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
100 lines
2.1 KiB
ReStructuredText
100 lines
2.1 KiB
ReStructuredText
About This Extension
|
|
====================
|
|
Describe the extension.
|
|
|
|
Who will use it and what project's API it is for?
|
|
|
|
How can I find out more about it?
|
|
|
|
Are there any pre-requisites prior to using it such as special hardware or configuration?
|
|
|
|
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://mycloud.com/v1.1/tenant/extensions.
|
|
|
|
Extension Overview
|
|
------------------
|
|
|
|
Name
|
|
Name of Extension
|
|
|
|
Namespace
|
|
http://docs.openstack.org/<project>/api/ext/tla/v1.0
|
|
|
|
Alias
|
|
ORG-EXT
|
|
|
|
Contact
|
|
Name <email@mailingaddress.net>
|
|
|
|
Status
|
|
Alpha, Beta, or Released
|
|
|
|
Extension Version
|
|
v1.0 (year-mm-dd)
|
|
|
|
Dependencies
|
|
Name and Version of API
|
|
|
|
Doc Link (PDF)
|
|
http://
|
|
|
|
Doc Link (WADL)
|
|
http://
|
|
|
|
Short Description
|
|
This extension enables ...
|
|
|
|
Sample Query Responses
|
|
----------------------
|
|
|
|
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
|
|
|
Extension Query Response: XML::
|
|
|
|
N/A
|
|
|
|
Extension Query Response: JSON::
|
|
|
|
N/A
|
|
|
|
Document Change History
|
|
-----------------------
|
|
|
|
============= =====================================
|
|
Revision Date Summary of Changes
|
|
yyyy-mm-dd Describe the change, one line per rev
|
|
============= =====================================
|
|
|
|
|
|
Summary of Changes
|
|
==================
|
|
This extension to the <project> API allows ...
|
|
|
|
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
|
|
|
New Action
|
|
----------
|
|
List the actions each in a section. Enter "None" if there are no changes.
|
|
|
|
Include the response codes, transitions if applicable, and XML and JSON examples.
|
|
|
|
New Faults
|
|
----------
|
|
|
|
New Headers
|
|
-----------
|
|
|
|
New Resources
|
|
-------------
|
|
|
|
New States
|
|
----------
|
|
|
|
Changes to the Cloud Servers Specification
|
|
------------------------------------------
|
|
|
|
List the specific changes to the API. For example:
|
|
|
|
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
|
|
|
|
Provide examples in XML and JSON
|