189 Commits

Author SHA1 Message Date
Zuul
3f85754e0a Merge "[Doc] Fix parameters in share network api-ref" 2017-11-13 00:29:21 +00:00
zhongjun
cd77c128b0 Add API document for share group [3/3]
This patch adds a new API document for share group snapshot.

Partial-Bug: 1724716
Change-Id: I832d264eb220027aad32937dc64a6ca428ee55a4
2017-11-02 16:38:16 +00:00
zhongjun
3da1c7d4fb Add API document for share group [2/3]
This patch adds a new API document for share group

Partial-Bug: 1724716
Change-Id: I852d264eb120027aad32997dc64a6ca128ee55a3
2017-11-02 16:35:11 +00:00
zhongjun
9f2f05ffc4 Add API document for share group [1/3]
This patch adds a new API document for share group type.

Partial-Bug: 1724716
Change-Id: I852d264eb120027aad32997dc64a6ca428ee55a4
2017-10-31 10:06:34 +00:00
zhongjun
3dba4d4715 [Doc] Fix parameters in share network api-ref
* Change description parameter 'required' attr value
  from true to false.
* Add neutron_net_id and neutron_subnet_id in share
  network update API request parameter.

Closes-bug: #1727145
Change-Id: Iedde7a2a674a60e760b47d5eb2973f42d79223d1
2017-10-25 03:45:49 +00:00
Zuul
c86e7658af Merge "[Doc] Add share group in doc" 2017-10-24 15:24:25 +00:00
zhongjun
0d4a317adb [Doc] Add share group in doc
Separate add share group description in other API or CLI echo in
this patch from add share group itself description in other patches:
Added share group iteslf in api-ref [1]
Added share api admin doc [2]
Added share group in driver requirements [3]

[1] I852d264eb120027aad32997dc64a6ca428ee55a4
[2] Ia0cc534e0bfb2ca5e495e575237e9911c746691b
[3] Iedde5a9a774a60e760b47d5eb2973f42d79227d4

Change-Id: Iedde5a9a774a60e760b47d5eb2973f42d79127d3
2017-09-28 14:49:29 +00:00
Jenkins
56ca6db3b4 Merge "[Api-ref] Remove unused parameter extra_specs_2 in parameters.yaml" 2017-09-21 08:40:35 +00:00
Jenkins
a035da08b4 Merge "[Doc] Delete consistency group in doc" 2017-09-20 03:42:40 +00:00
junboli
90e5c8a1d7 Switch base to latest in link address
Using latest doc version instead of ocata version.


Change-Id: Ia71473a80f52b4839d677de6bd1f0202241f4048
2017-09-19 12:52:49 +00:00
zhongjun
804b81226c [Doc] Delete consistency group in doc
Since consistency group APIs were removed in 2.31 API version.
Now we delete consistency group description in docs.

Change-Id: I6499ae6c98d9489a257bb20febd6c1ddb9e17b12
2017-09-18 11:29:57 +08:00
Jenkins
0e3ad3917d Merge "[doc] Move Experimental APIs description to a common place" 2017-09-18 03:04:15 +00:00
zhongjun
c60f1fca88 [doc] Add API document for snapshot instances
This patch adds a new API document for snapshot instances.

Change-Id: Ia0cc534e0bfb2ca5e495e575e27e9911c746690b
2017-09-12 05:15:10 +00:00
Jenkins
51ba7b8e24 Merge "Fix html_last_updated_fmt in conf.py" 2017-09-10 09:39:17 +00:00
liuyamin
c47fa9829f [Api-ref] Delete the duplicate tenant arguments in parameters.yaml
In the parameters.yaml file, the description of tenant_id_path is the
same as tenant_id_1, so delete the parameter tenant_id_1.

Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
2017-09-09 13:22:58 -04:00
junboli
ee66db5dc9 Fix html_last_updated_fmt in conf.py
1. remove duplicate html_last_updated_fmt in doc/source/conf.py
   the second one cause the new added one not take effect.
2. update html_last_updated_fmt in api-ref/source/conf.py
   use the recommended '%Y-%m-%d %H:%M' data time format.

Change-Id: Ib37b8a05c88667b34438186c55b6eb3f64b64960
2017-09-09 23:01:08 +08:00
Jenkins
6a9fe9d493 Merge "Add API document for share replica" 2017-09-07 09:34:17 +00:00
zhongjun
514c1a05a1 Add API document for share replica
This patch adds a new API document for share replica.

Change-Id: Ia0cc534e0bfb2ca4e485e575e27e9911c746691b
2017-09-07 01:05:08 +00:00
zhongjun
eac27c40d9 [doc] Move Experimental APIs description to a common place
Change-Id: I41695632d48f7cbcbe008867671f8196b5543c93
2017-09-04 09:25:14 +00:00
liuyamin
43488d44ea [Api-ref] Remove unused parameter extra_specs_2 in parameters.yaml
Change-Id: Id841b05db6a034e97cbc031939d74827d87dc71b
2017-09-04 07:41:01 +00:00
Jenkins
33d5d49ada Merge "Add API document for share type quota" 2017-08-31 21:48:23 +00:00
zhongjun
976fd7b621 Add API document for share type quota
Add API document for share type quota [1].
[1] https://review.openstack.org/#/c/452158/

Change-Id: I8473428c2eb363cf5a76c672c7fdea72f21e4f63
2017-08-31 16:02:09 +00:00
Jenkins
62712a5522 Merge "Update the documentation link for doc migration" 2017-08-31 03:00:59 +00:00
Jenkins
9582169110 Merge "doc migration: update the doc link address" 2017-08-29 14:43:45 +00:00
Jenkins
e76d5ea607 Merge "[Doc] Fix access rule description in api-ref" 2017-08-28 18:38:01 +00:00
junboli
dd82e8f28b doc migration: update the doc link address
Update the doc link brought by the doc migration.

Change-Id: I6000856c22dbc47a1349d061927a47405ba0d66c
2017-08-28 16:38:05 +08:00
zhiguo.li
f50734a937 Update the documentation link for doc migration
Update the link  of microversion guideline for manila in file
versions.inc

Change-Id: I24b500cc1acd031572fff22810f357d0ed0afcb5
2017-08-28 04:29:22 +00:00
zhongjun
b04fa3998c [Doc] Fix access rule description in api-ref
Added ipv6 description in ip rule.
Change user rule characters long from 32 to 255.

Change-Id: Ief71b9912c2c84e0df1d12d303517fa20ff7908b
2017-08-15 02:40:25 +00:00
Jenkins
7010483cc9 Merge "[Doc] Add more description to user messages api-ref" 2017-08-15 00:02:36 +00:00
Jan Provaznik
2ef9da3082 [Doc] Add more description to user messages api-ref
Change-Id: I8954d4afb1963663f404a15bea07f957aa99796c
Closes-Bug: #1706096
2017-08-14 14:38:49 +00:00
junboli
154db2926c [Api-ref] remove "is_public" in snapshot updated description
In api-ref/source/snapshot.inc, when update a snapshot, we can only update
its "display_name" and "display_description", is_public can not be updated,
So this change is to remove "is_public" in update snapshot description.

Change-Id: I02109fc032df4bbf8ef487a567c7dd8d1d9c66ce
Closes-bug: #1710523
2017-08-14 08:50:42 +08:00
Jenkins
c6f073be24 Merge "Fix wrong links" 2017-08-11 17:22:28 +00:00
yfzhao
c408401864 Fix wrong links
Some docs links have changed. We should update the wrong links in our codes.

Closes-Bug #1710106

Change-Id: I2704fbf947564dcfe5871d38080bf6c8fcc43837
2017-08-11 16:44:28 +08:00
junboli
05b5f7ab69 [Api-ref] Add supported protocol "MAPRFS" in doc
Now that the "MAPRFS" has been supported by manila driver,
but this is missing in share.inc docs, this change is to add
it.

Change-Id: If2bd03786738469bb2e98683719a3bb164c181ae
2017-08-11 16:25:43 +08:00
Jenkins
6f2c8d45eb Merge "Add API document for share group quotas" 2017-08-11 02:29:14 +00:00
Jenkins
f1d9e0d91c Merge "[Doc] Remove unused 'provider_location' parameter" 2017-08-11 02:24:47 +00:00
zhongjun
52ea955a89 Add API document for share group quotas
"Quota" APIs now will return two new following keys [1]:

- 'share_groups'
- 'share_group_snapshots'

[1] https://review.openstack.org/#/c/473464/

DocImpact
Partially Implements BluePrint add-share-groups-quota
Change-Id: I497a8e886236cb22fa50abdf2a4a938bb04c655d
2017-08-10 12:07:07 +00:00
zhongjun
fae39f700d [Doc] Remove unused 'provider_location' parameter
TrivialFix

Change-Id: Ia0cc334e0bfb2ca5e495e575e27e9911c746691b
2017-08-10 10:35:14 +00:00
zhongjun
ee5fd420f3 [Doc] Fix API document for Consistency group
The Consistency groups and Consistency snapshot group
APIs were removed in 2.31 API version [1]. Now add the
version decription in api-ref.
[1] https://review.openstack.org/#/c/335093/


Change-Id: I79a80a62ae4e0015d6161edc3b93fd1f9ba69538
2017-08-10 10:33:45 +00:00
zhangdaolong
e37f1eb435 Remove duplicate variables.
Change-Id: I7d5a0ebe904a91af5f2f9a13d873d2558bbb51fe
2017-08-05 09:50:21 +08:00
Jenkins
d3d6fc04e7 Merge "Added like filter in api-ref" 2017-07-19 00:56:02 +00:00
Jenkins
0ebb762c0c Merge "Update the documentation link for doc migration" 2017-07-17 15:58:25 +00:00
zhongjun
a8268829f9 Added like filter in api-ref
Change-Id: I704591446cd5f6ad2293c5a18eccf5412d487baf
2017-07-17 03:25:22 +00:00
chenxing
082159cc54 Update the documentation link for doc migration
Change-Id: I0b4e59c9e2ad0375cdb6aae5369a7b43978c3d69
2017-07-14 07:27:16 +00:00
Alex Meade
dd630c3929 User Messages
For quite some time, OpenStack services have wanted to be able to send
messages to API end users (by user I do not mean the operator, but the
user that is interacting with the client).

This patch implements basic user messages with the following APIs.
GET /messages
GET /messages/<message_id>
DELETE /messages/<message_id>

Implements the basic /messages resource and tempest tests
The patch is aligned with related cinder patch where possible:
I8a635a07ed6ff93ccb71df8c404c927d1ecef005

DocImpact
APIImpact

Needed-By: I5ffb840a271c518f62ee1accfd8e20a97f45594d
Needed-By: I9ce096eebda3249687268e361b7141dea4032b57
Needed-By: Ic7d25a144905a39c56ababe8bd666b01bc0d0aef

Partially-implements: blueprint user-messages
Co-Authored-By: Jan Provaznik <jprovazn@redhat.com>
Change-Id: Ia0cc524e0bfb2ca5e495e575e17e9911c746690b
2017-07-13 13:05:57 +02:00
zhongjun
f1fbc5952d Add export-location filter in share and share instance list API
Share and share instance list API will accept new query string parameter
'export_location'. It can pass path and id of export_location to
retrieve shares filtered.

APIImpact

Partly-implement: BP support-filter-share-by-export-location
Change-Id: I5fdf6d89d0b6c7fa182ddfaac60979bc6c0fc2a6
2017-06-29 18:06:21 +00:00
Jenkins
490ddb7c1b Merge "Change to share access list API" 2017-05-08 04:40:06 +00:00
yangweiwei
5a8c3c11b9 Change to share access list API
When we do manila access-list, the 'created_at' and 'updated_at' time
should be shown to the user. And then the user could determine which
is the recent access rule. As the design, the recent access-allow
rule caused the error access-status of share instance.

APIImpact
Closes-Bug: #1682795
Change-Id: Iad6070d60ec77b7de9cc9679cfa7478876084da1
2017-05-05 17:19:25 +08:00
YuYang
c7a2b21d7d api-ref:Update ref link
update the manila api-ref link and install-guide like use latest.

Change-Id: I17b18630b5082935b71e29a9edb5e03e58610881
2017-05-02 10:41:55 +08:00
rajat29
1a9768ac58 Fix api-ref doc generation for Python3
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Closes-bug: #1685147

Change-Id: I6afe143d4db08562b253d130d536d701b1606824
2017-04-21 10:22:23 +00:00