3 Commits

Author SHA1 Message Date
xiexs
f63d89dd3b Add proper scheduler_hint key to dev-ref
In the dev-ref, the hint key for volume create API
should be 'OS-SCH-HNT:scheduler_hints' but not 'scheduler_hints'.
Furthermore, it should be parallel with the key 'volume'.
To be more clear fix the example as well.

Change-Id: I999aebb0e53ebac5dc121ef1ccdc98f9d5ac816a
2016-07-04 00:11:49 -04:00
Sheel Rana
41929d1c7a migrate to os-api-ref
os-api-ref is released now, so we can move to using it instead
of copy pasting in cinder tree.

Change-Id: Id38dd0609c77b0d6bcd0d935a9312b0211134802
2016-06-09 10:35:02 +00:00
Sheel Rana
8659ff0ef5 WADL to RST migration in cinder tree
This patch is for converting API Reference to RST and host it
in the Cinder tree.
This patch contains all the RST for cinder to bring over to their
repos to begin building API reference information from within.
This contains .inc files which have all the contents of the .rst files
but are grouped together for easier editing

This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API.

Cleaning task will be done once this part is merged.

As we have removed XML API support in Newton release, we need to
remove XML from API reference as well.

But we still have installations which are using XML.
So implementation plan is to first merge this patch in Newton release
keeping XML for now, then I will backport same to stable branches.
After that I will remove same from Newton release to match API
reference with actual API implementation.

Implements: bp api-reference-to-rst
Change-Id: I865ac922538bfa5bd45c24eb4bc49f5e966dc811
2016-05-12 19:07:30 +00:00