16 Commits

Author SHA1 Message Date
Takashi NATSUME
1a0a04dc05 api-ref: Fix an expand button in os-quota-sets
If section reference name is changed not to overlap,
when the 'List Default Quotas For Tenant' API section
is collapsed, it cannot be followed by users.
So the reference is changed to the 'os-quota-sets' chapter.

Change-Id: Ic61b38cabde3b3225f778833f0e7aae6acf5eabc
Closes-Bug: #1705191
2017-07-19 16:32:43 +09:00
ghanshyam
e332797e42 Add 'networks' quota in quota sample files
'networks' quota can be available based on config value.
api-ref should show that for quota-set APIs and also sample files
so that it can be tested somewhere.

Also adding it to quota class APIs sample files also.
Closes-Bug: #1702201

Change-Id: I84d562a8ca10826dea4675d74669b5de64ff0ed0
2017-07-04 23:45:30 +00:00
ghanshyam
b25b66e284 Add api-ref for os-quota-class-set APIs
This commit adds the api doc for os-quota-class-set GET & PUT
APIs.

- Also mentioned about the recommendation over usage of this API.
- Added warning for current bug in v2.1 API #1693168

This is also needed by BP
- https://blueprints.launchpad.net/nova/+spec/fix-quota-classes-api

Change-Id: Ib765e2d1dec7b236a2009148e0b1067a46326ce9
Related-Bug: #1693168
Closes-Bug: #1602400
2017-07-04 17:40:56 +03:00
Sean Dague
f6fbfc7ff0 Verify project_id when quotas are checked
Implements bp:validate-project-with-keystone

Change-Id: I240f3395590bdccae03690f1c8a519dcc58d51e9
2017-02-22 16:43:05 +00:00
Takashi NATSUME
69f27a7ced api-ref: Fix parameters and response in os-quota-sets.inc
The type of 'quota_set' is changed to 'object'.
Add a missing response description of DELETE method.

Change-Id: I0a51861c68866303734a1d161b85689e1a3ba636
Closes-Bug: #1653897
2017-01-16 00:12:20 +00:00
Kevin_Zheng
391911028c Example and body verification of os-quota-sets.inc
This patch verifies the examples and body of
os-quota-set.inc

part of bp:api-ref-in-rst

Change-Id: I1e044c0dc9dbe4e5d123d6d8254a5a9347187f83
2016-07-15 10:12:56 +08: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
Kevin_Zheng
2813c837f6 api-ref: parameter verification for os-quota-sets
checked parameters

Part of bp:api-ref-in-rst

Change-Id: I0c43e83214aa4a0a54d553ab5c2ef79413753664
2016-05-16 14:48:06 +08:00
He Jie Xu
e7bf2d7dc6 Complete method verification of os-quotas
Adjust the order of method and correct the error status code. Also
add missing method of detail.

Part of bp:api-ref-in-rst

Change-Id: I394e906c05475d133a89d098e8282e047ebc6c31
2016-05-09 10:09:40 +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
4d421c7151 Fix sample file path for 4 files
This fix sample file path and status code of evacuate

Part of bp:api-ref-in-rst

Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
Jenkins
2325ee56f3 Merge "Fix api ref for os-hosts, os-quota-sets and os-fping" 2016-04-19 23:25:53 +00:00
Kevin_Zheng
b9a89c97a8 Fix api ref for os-hosts, os-quota-sets and os-fping
This patch fix API ref for correct sample files and status code
for below APIs
- os-hosts
- os-quota-sets
- os-fping

Part of bp:api-ref-in-rst

Change-Id: I7ecfe5adf4d8f1e9c767bac9194d9160f09fbee9
2016-04-19 21:18:12 +08: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