12 Commits

Author SHA1 Message Date
Sean McGinnis
d5b539be36
Doc8: Stop skipping D001: Line too long
This cleans up the cases where we had D001 violations so we can stop
skipping that check in doc8 runs.

Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 16:51:56 -06:00
whoami-rajat
1323ef7383 API-REF:os-quota-sets v2 API reference has the wrong parameters
The request/response parameters for the v2 os-quota-sets API
reference is copied from the compute API and is therefore wrong
for the block storage API:
https://developer.openstack.org/api-ref/block-storage/v2/#quota-sets-extension-os-quota-sets

This patch replaces the wrong response with the correct parameters.

Change-Id: I6df1d60843943c99505a735a6dec4f47270a1c2e
Closes-Bug: #1794125
2018-10-03 23:05:17 +05:30
junboli
8ee82f04e6 Missing request parameters in update quotas
"backup_gigabytes" and "per_volume_gigabytes" parameters
are supported in api v2, they aren't mentioned in api v2
document[1]. On the other hand both of them are mentioned
in api v3 document[2].

[1] https://developer.openstack.org/api-ref/block-storage/
    v2/index.html#update-quotas
[2] https://developer.openstack.org/api-ref/block-storage/
    v3/index.html?highlight=backup_gigabytes#update-quotas
    -for-a-project

Change-Id: I135efd5c2b4735f5821922643926390976453bf5
Closes-bug: #1727631
2018-05-29 20:03:51 +08:00
Sean McGinnis
a96fad9f3b Fix api-ref response code title levels
Using the wrong character resulted in the wrong title level
being used for the response codes, which in turn caused the
"detail" show/hide toggle to not be able to hide all of the
per-endpoint details. This corrects these to be at the correct
level.

Also ran into issues after changing them where sphinx was not
happy with the random title levels. This appears to be due to
the order processed and whether not earlier included files had
all subsequent levels. Adding an additional title in our first
included file resolved that problem.

Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03
Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
Sean McGinnis
2e5a91da72 Use rest_status_code for api-ref response codes
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.

https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code

Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-08 21:59:37 -06:00
TommyLike
7fdf33b4be Update the description of quota's project id
Instead of QoS id, project id should be used for
quota's id attribute.

Change-Id: I201350caa984b66baf38ce9d74d09c7eda913034
2018-01-25 11:38:19 +08:00
lihaijing
4403ed17ca Api-ref: change 'tenant' to 'project' in v2 doc
Since 'tenant' is the old term, all things should now refer to 'project'.

Change-Id: I3a255df758583a3c4301041c8ebffb90b8263fef
2017-09-27 18:14:25 +08:00
Sean McGinnis
117f614428 api-ref: Normalize response codes
We had a mix of formatting for our API response codes. This
makes it so all have a leading space, no trailing comma, and
no empty Error response labels.

This also addresses a formatting issue with due to the spacing
between the Normal and Error lines that was causing the two to
run together in the formatted HTML, making it harder to read.

Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
2017-09-03 18:17:13 -05:00
Andrey Volkov
8235e6e1e2 api-ref cleanup: required flag for tenants
Current url scheme doesn't allow to skip admin_tenant_id
or tenant_id params. This change marks them as required
in api-ref. Get default quotas for a project signature
was changed on correct also.

Partial-Bug: #1415214

Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3
2017-05-23 14:48:48 +00:00
Andrey Volkov
cf8eee3f5b api-ref cleanup: remove quotas user related calls
os-quota-sets API call doesn't provide an ability to work with a user. PUT
and DELETE methods return "Bad key" error message when user_id is used.
GET method just ignores user_id key. In addition, there is not table for
storing user related limits as in nova.

This change removes the following calls from v1, v2, v3 API descriptions:
- Show quotas for user
- Update quotas for user
- Delete quotas for user
- Show quota details for user

Partial-Bug: #1415214
DocImpact

Change-Id: Ib38f12132f8c4a1f4177e2450e734fffa400dad4
2017-03-07 14:55:55 +03:00
Nicholas Jones
aa9cabdb42 Fix Block Storage API reference nesting
Modifies heading levels in .inc files to allow nested display in
table of contents. Table of contents depth has been changed to allow
this.

Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-09 08:37:27 -06:00
Sheel Rana
7f2131e3a1 Update api-ref path
api-ref path needs update to support uploading cinder api-refs to
developer.openstack.org/api-ref/block-storage

update includes
https://github.com/openstack/cinder/tree/master/api-ref/v2/source
to
https://github.com/openstack/cinder/tree/master/api-ref/source/v2

Depends-on: Id38dd0609c77b0d6bcd0d935a9312b0211134802

Implements: bp api-reference-to-rst

Change-Id: If3a058a95f1eaa8481a926183591ff0f4b23e97b
2016-08-27 16:58:10 +02:00