168a50057032ad8cc028aabc261733bebb50a51d
Commit Graph

10 Commits

Author SHA1 Message Date
Takashi NATSUME
a7cbc90fb1 api-ref: Improve os-instance_usage_audit_log samples
Improve api samples for os-instance_usage_audit_log
and fix a parameter.
Change-Id: I8436a6ab0610e41d8c6c95c55a263fdfbbf58476
Implements: blueprint api-ref-in-rst
2016年06月21日 20:30:11 +09:00
Takashi NATSUME
58785c4a67 api-ref: Fix parameters in os-instance-usage-audit-log
The parameters have been verified in
Ia7af3cab3c0ed82418a6fa140fea061074ccd8b5.
But response parameters are missing, so fix them.
And fix some wrong description.
Change-Id: Ic1a307c405f769cadd037ae45e921d88b6a2bea5
Implements: blueprint api-ref-in-rst
2016年06月14日 13:58:54 +09:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
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
2016年06月03日 08:47:33 -04:00
jichenjc
57ab504cc1 verify api-ref os-instance-usage-audit-log.inc
verify the parameters, os-instance-usage-audit-log.inc
including response and request.
Changed some wording such as 'Instance' -> 'Server' etc.
Part of bp:api-ref-in-rst
Change-Id: Ia7af3cab3c0ed82418a6fa140fea061074ccd8b5
2016年04月27日 23:43:43 +08:00
Sivasathurappan Radhakrishnan
8d68435bae method verification of os-instance-usage-audit-log
Verified the API document for os-instance-usage-audit-log
with source for methods available and response codes.
Part of bp:api-ref-in-rst
Change-Id: Idaacc174054f909e542cdfb0879396ff76a84996
2016年05月11日 17:14:53 +00:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
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
2016年04月20日 16:21:58 -04:00
ghanshyam
aa0bb597c6 Fix sample file path for os-i* API
This patch fix sample files path for os-i* APIs
Part of bp:api-ref-in-rst
Change-Id: I0d8de9aaef7ffe5e0dfe09f38246b1f57ac814cb
2016年04月20日 11:38:31 +09:00
ghanshyam
6f8cda2f39 Fix json response example heading in api ref
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
2016年04月19日 17:56:20 +09:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
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
2016年04月15日 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
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
2016年04月13日 07:34:45 -04:00