~0x44/nova/extdoc

« back to all changes in this revision

Viewing changes to nova/api/openstack/contrib/doc/rst_extension_template.rst

  • Committer: Anne Gentle
  • Date: 2011-09-15 03:07:06 UTC
  • Revision ID: anne@openstack.org-20110915030706-oukxthnhst8xswnf
Adds extension documents for extensions in /contrib/doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
About This Extension
 
2
====================
 
3
Describe the extension. 
 
4
 
 
5
Who will use it and what project's API it is for? 
 
6
 
 
7
How can I find out more about it? 
 
8
 
 
9
Are there any pre-requisites prior to using it such as special hardware or configuration?
 
10
 
 
11
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.
 
12
 
 
13
Extension Overview
 
14
------------------
 
15
 
 
16
Name
 
17
        Name of Extension
 
18
        
 
19
Namespace
 
20
        http://docs.openstack.org/<project>/api/ext/tla/v1.0
 
21
 
 
22
Alias
 
23
        ORG-EXT
 
24
        
 
25
Contact
 
26
        Name <email@mailingaddress.net>
 
27
        
 
28
Status
 
29
        Alpha, Beta, or Released
 
30
        
 
31
Extension Version
 
32
        v1.0 (year-mm-dd)
 
33
 
 
34
Dependencies
 
35
        Name and Version of API
 
36
        
 
37
Doc Link (PDF)
 
38
        http://
 
39
        
 
40
Doc Link (WADL)
 
41
        http://
 
42
        
 
43
Short Description
 
44
        This extension enables ...
 
45
 
 
46
Sample Query Responses
 
47
----------------------
 
48
 
 
49
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
 
50
 
 
51
Extension Query Response: XML::
 
52
 
 
53
 
 
54
Extension Query Response: JSON::
 
55
 
 
56
 
 
57
Document Change History
 
58
-----------------------
 
59
 
 
60
============= =====================================
 
61
Revision Date Summary of Changes
 
62
yyyy-mm-dd    Describe the change, one line per rev
 
63
============= =====================================
 
64
 
 
65
 
 
66
Summary of Changes
 
67
==================
 
68
This extension to the <project> API allows ...
 
69
 
 
70
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
 
71
 
 
72
New Action
 
73
----------
 
74
List the actions each in a section. Enter "None" if there are no changes. 
 
75
 
 
76
Include the response codes, transitions if applicable, and XML and JSON examples.
 
77
 
 
78
New Faults
 
79
----------
 
80
 
 
81
New Headers
 
82
-----------
 
83
 
 
84
New Resources
 
85
-------------
 
86
 
 
87
New States
 
88
----------
 
89
 
 
90
Changes to the Cloud Servers Specification
 
91
------------------------------------------
 
92
 
 
93
List the specific changes to the API. For example: 
 
94
 
 
95
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. 
 
96
 
 
97
Provide examples in XML and JSON
 
 
b'\\ No newline at end of file'