This fixes the link, re-words it a bit, moves it to the main
description (since it applies to PUT also) and drops the note
since we don't need note formatting for linking in reference
material.
Closes-Bug: #1814953
Change-Id: Ia24cda353bdcadf3fe8405aac588e8abf1100608
In the current api-ref, we have illustrated
about how to add extra specs for flavors,
but it was very simple and we have a large
number of built-in extra specs that can be
used to archive different purpose listed here:
http://docs.openstack.org/admin-guide/compute-flavors.html
The reader will still be confused about how
to correctly use extra specs only read the
api-ref. We could first simply add the above
link to the flavor extra spec section in
api-ref to let readers know where to find
information and come up with better solution
later.
Change-Id: Ie720973783f153d3954be9f4bd97e7f9bf788c6b
Closes-bug: #1640654
This includes parameter, example, and body verifications
for api-ref os-flavor-extra-specs.
part of bp:api-ref-in-rst
Change-Id: Ifa7766934da95c3b2da20b71a7733883c70f7c80
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
verified the API doc for os-flavor-extra-specs,
changes the sequence of GET/POST,
Also, remove some common error code like 500, 503 etc
Part of bp:api-ref-in-rst
Change-Id: I14c02e42f2cbb7979436add78feb19a41944a1c7
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
Heading for json response example is wrong,
it is json request instead of json response.
Part of bp:api-ref-in-rst
Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
flavor-access and flavor-extras api-ref has wrong reference
this patch fixed it.
Part of bp:api-ref-in-rst
Change-Id: I07fed203b2f3908bade0e087265384349e21830c
In the sphinx document h3 is supposed to be '-' not '^':
=, for sections
-, for subsections
^, for subsubsections
We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.
Part of bp:api-ref-in-rst
Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
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 document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26