openstack/manila
Code Issues Proposed changes

[Doc] Fix access rule description in api-ref

Browse Source 
Added ipv6 description in ip rule.
Change user rule characters long from 32 to 255.

Change-Id: Ief71b9912c2c84e0df1d12d303517fa20ff7908b
This commit is contained in:
zhongjun 2017-08-11 14:28:47 +08:00 committed by zhongjun
parent 6f2c8d45eb
commit b04fa3998c
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
api-ref/source/share-actions.inc
View File

@ -47,9 +47,16 @@ To grant access, specify one of these supported share access levels:
You must also specify one of these supported authentication You must also specify one of these supported authentication
methods: methods:
- ``ip``. Authenticates an instance through its IP address. A valid - ``ip``. Authenticates an instance through its IP address.
format is ``XX.XX.XX.XX`` or ``XX.XX.XX.XX/XX``. For example The value specified should be a valid IPv4 or an IPv6 address,
``0.0.0.0/0``. or a subnet in CIDR notation.
A valid format is ``X:X:X:X:X:X:X:X``, ``X:X:X:X:X:X:X:X/XX``,
``XX.XX.XX.XX``, or ``XX.XX.XX.XX/XX``, etc. For
example ``0.0.0.0/0`` or ``::/0``.
.. important::
IPv6 based access is only supported with API version 2.38 and beyond.
- ``cert``. Authenticates an instance through a TLS certificate. - ``cert``. Authenticates an instance through a TLS certificate.
Specify the TLS identity as the IDENTKEY. A valid value is any Specify the TLS identity as the IDENTKEY. A valid value is any
@ -59,7 +66,7 @@ methods:
- ``user``. Authenticates by a user or group name. A valid value is - ``user``. Authenticates by a user or group name. A valid value is
an alphanumeric string that can contain some special characters an alphanumeric string that can contain some special characters
and is from 4 to 32 characters long. and is from 4 to 255 characters long.
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action .. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action