John Kennedy a68156c100 bug 965335

Resolves unclear formatting of compute extensions documentation at
http://nova.openstack.org/api_ext/index.html

The rst extensions template has been updated to include extension name as
top level hierarchy, and demote all other content.

All existing documentation pages have been reformatted as per the updated
template.

The ext_aggreagates.rst file has also been added to index.rst.

Amendments:
 - Author added to Authors file
 - Typo in ext_volumes.rst fixed

Change-Id: Id67ef91a6e8eaaf4fba46abbd57759c77aaf8991

2012-03-30 15:20:58 +01:00

2.2 KiB

Raw Blame History

The <Name of Extension> Extension

About this Extension

Describe the extension.

Who will use it and what project's API is it for?

How can I find out more about it?

Are there pre-requisites prior to using it such as special hardware or configuration?

To obtain current information on 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/etensions.

Extension Overview

Name: Name of Extensions
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:

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 ...

This support is provided by the addition of new <actions, faults, headers, resources, states, something else>.

New Actions

List each action 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

2.2 KiB Raw Blame History