some api-ref have sentence like '..for a server instance'
which is inconsistent and confusing as we use server for VM terminology.
I think here 'instance' word is being considered object of server which
is wrong.
We should always mention server only.
part of bp:api-ref-in-rst-pike
Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
not set LC_ALL=en_US.UTF-8 might get some error like:
(UnicodeEncodeError): 'ascii' codec can't encode character u'\ufffd'
add document update to indicate this to user as this is user related.
Change-Id: I9c39da5411b3080c46f557ba27ffa06a37086b7d
Related-Bug: 1650051
- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
Review and change as needed.
Implements: bp/api-ref-in-rst-ocata
Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
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
This provides the verification of the action console output.
* Return codes updated based on what's in the code
* Parameters fixed (length -1 is not actually a thing, it's suggestion
for future enhancement; console output described; server_id should be in path).
* Add preamble for request example
* Clean up language on preamble
Part of bp:api-ref-in-rst
Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b
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
The api sample reference is not correct
fix incorrect return value.
1. servers-action-console-output.inc
2. servers-action-crash-dump.inc
Part of bp:api-ref-in-rst
Change-Id: Id0d946478a6a59f63f22117944309d3eb66013d3
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