Commit Graph

13 Commits

Author SHA1 Message Date
jichenjc
f81e32c9d1 Add more description when service delete
As service delete will affect host aggregate, add more info

Change-Id: I57b17f60228df83a033735c33cc74589dad30553
Implements: blueprint api-ref-in-rst-ocata
2016-09-21 20:18:18 +08:00
Chen Fan
377948b059 api-ref: unify the delete response infomation
part of bp:api-ref-in-rst

Change-Id: I924a632253b8b1c25f987c259d255cc6440f52f2
2016-07-07 10:23:34 +08:00
Karen Bradshaw
3cdb385dac api-ref, os-services.inc
Verified parameters, examples, body text.
Included v2.11 sample files for GET and PUT
os-services.

Part of: bp/api-ref-in-rst

Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b
2016-06-21 11:39:30 -04: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
Sean Dague
36c688f694 api-ref: finish validation for os-server-external-events.inc
This completes the validation for the admin event interface, including
detailing the codes we currently return in the parameter list.

Because os-service was incorrectly using the 'status' key, when I
renamed status => event_status I needed to also create a
service_status to make things compile. It's accurate enough to move
forward.

Because this is really a Neutron only API, this is moved towards the
bottom of the API list, to make it clear this isn't really designed to
be used by end user apps.

Part of bp:api-ref-in-rst

Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56
2016-05-13 13:35:24 +00:00
jichenjc
ef2dfbf717 Complet Method Verification of os-services
This complete the Method Verification of os-services,
http://paste.openstack.org/show/495349/
has the method call and return sample value. also,
clean and correct some error return code.

Part of bp:api-ref-in-rst

Change-Id: Ie4662e033b3b2235e62fd95ea50291ae91362d21
2016-04-22 17:15:42 +08: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
Sean Dague
1555736e3c Final warnings removals for api-ref
This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.

It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.

Part of bp:api-ref-in-rst

Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
2016-04-20 11:25:30 -04:00
Sean Dague
4e415274f3 fix samples references in os-services
This fixes all the samples references in os-services to not throw
warnings.

Part of bp:api-ref-in-rst

Change-Id: I25b469352a4f99e34783eb31ea3b94e4d9971477
2016-04-19 14:08:33 -04: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
jichenjc
e9cb0aa036 Fix os-service related reference missing
"Delete a service " API returns 204 as success, 404 is error
Also some reference to doc it not correct

Part of bp:api-ref-in-rst

Change-Id: Ibf57167ae70acdaa2ad6f0abc3a975c91e797b87
2016-03-23 10:25:11 +08: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