Hi Netstackers,
While I'm completing the operation list on the API documentation book, I'd be
glad if I could get some help into adding a section on extensions.
Other <extendable> services, such as nova-compute, have a section describing
how to fetch the extension list and details for each registered extensions.
I think we should have a section for extension also in Quantum documentation;
as our extension framework is "inspired" to nova's I think the documentation
should be fairly similar; however we should probably add something to discuss
plugin-aware extensions.
I've drafted a section for extensions, which is attached to this email. It
would be great if the guys which contributed the extension framework code (or
used it to develop extensions) could have a look at this draft, and complete it.
Thanks in advance,
Salvatore
<section xml:id="Extensions">
<title>Extensions</title>
<para>
The Quantum API is extensible. Extensions
serve two purposes: They allow the introduction of new
features in the API without requiring a version change
and they allow the introduction of vendor specific
niche functionality. Applications can programmatically
determine what extensions are available by performing
a &GET; on the <code>/v1.0/extensions</code> URI.
Note that this is a versioned request — that is,
an extension available in one API version may not be
available in another.
</para>
<example>
<title>Extensions Response: XML</title>
<programlisting language="xml"><?db-font-size 90%?>
<xi:include href="samples/extensions.xml" parse="text"/>
</programlisting>
</example>
<?hard-pagebreak?>
<example>
<title>Extensions Response: JSON</title>
<programlisting language="javascript"><?db-font-size 90%?><xi:include
href="samples/extensions.json" parse="text"/></programlisting>
</example>
<?hard-pagebreak?>
<para>
<note>
Please insert some more details about the extension mechanism here.
</note>
</para>
<important>
<para>
Applications should be prepared to ignore response
data that contains extension elements. An
extended state should always be treated as an
<code>UNKNOWN</code> state if the application does
not support the extension. Applications should
also verify that an extension is available before
submitting an extended request.
</para>
</important>
</section>
--
Mailing list: https://launchpad.net/~netstack
Post to : netstack@lists.launchpad.net
Unsubscribe : https://launchpad.net/~netstack
More help : https://help.launchpad.net/ListHelp
