~0x44/nova/extdoc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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/extension.

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


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

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