[api-ref] Refactor share actions API documentation
This patch makes share actions API documentation be more readable and maintainable. Change-Id: I388bdc4d9f22eda50fbede1106afebba6ceb355f
This commit is contained in:
parent
f427dfe00b
commit
46584eeec9
@ -453,20 +453,6 @@ access_level:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_level_1:
|
||||
description: |
|
||||
The share access level. A valid value is either:
|
||||
- ``rw``. Read and write (RW) access. - ``ro``. Read-only (RO)
|
||||
access.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_level_2:
|
||||
description: |
|
||||
The share access level.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_list:
|
||||
description: |
|
||||
The object of the access rule. To list access
|
||||
@ -474,6 +460,50 @@ access_list:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_rule_created_at:
|
||||
description: |
|
||||
The date and time stamp when the access rule was created.
|
||||
|
||||
The date and time stamp format is `ISO 8601
|
||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||
|
||||
::
|
||||
|
||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||
|
||||
The ``±hh:mm`` value, if included, returns the time zone as an
|
||||
offset from UTC.
|
||||
|
||||
For example, ``2015-08-27T09:49:58-05:00``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_rule_id:
|
||||
description: |
|
||||
The access rule ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_rule_updated_at:
|
||||
description: |
|
||||
The date and time stamp when the access rule was updated.
|
||||
|
||||
The date and time stamp format is `ISO 8601
|
||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||
|
||||
::
|
||||
|
||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||
|
||||
The ``±hh:mm`` value, if included, returns the time zone as an
|
||||
offset from UTC.
|
||||
|
||||
For example, ``2015-08-27T09:49:58-05:00``.
|
||||
|
||||
If the access rule was never updated, this value is ``null``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_rules_status:
|
||||
description: |
|
||||
(Since API v2.10) The share instance access rules
|
||||
@ -489,6 +519,20 @@ access_rules_status_1:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_share_id:
|
||||
description: |
|
||||
The UUID of the share to which you are granted
|
||||
or denied access.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_status:
|
||||
description: |
|
||||
The share access status, which is ``new``,
|
||||
``error``, ``active``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_to:
|
||||
description: |
|
||||
The value that defines the access. The back end
|
||||
@ -506,23 +550,6 @@ access_to:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_to_1:
|
||||
description: |
|
||||
The access that the back end grants or denies. A
|
||||
valid value for the share access rule type is one of these values:
|
||||
- ``ip``. Authenticates an instance through its IP address. A
|
||||
valid format is ``XX.XX.XX.XX`` or ``XX.XX.XX.XX/XX``. For
|
||||
example ``0.0.0.0/0``. - ``cert``. Authenticates an instance
|
||||
through a TLS certificate. Specify the TLS identity as the
|
||||
IDENTKEY. A valid value is any string up to 64 characters long
|
||||
in the common name (CN) of the certificate. The meaning of a
|
||||
string depends on its interpretation. - ``user``. Authenticates
|
||||
by a user or group name. A valid value is an alphanumeric string
|
||||
that can contain some special characters and is from 4 to 32
|
||||
characters long.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_type:
|
||||
description: |
|
||||
The access rule type. A valid value for the
|
||||
@ -540,18 +567,6 @@ access_type:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_type_1:
|
||||
description: |
|
||||
The access type of an access rule.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
access_type_2:
|
||||
description: |
|
||||
The rule access type.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
alias:
|
||||
description: |
|
||||
The alias for the extension. For example,
|
||||
@ -1101,24 +1116,6 @@ created_at_5:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
created_at_6:
|
||||
description: |
|
||||
The date and time stamp when the access rule was created.
|
||||
|
||||
The date and time stamp format is `ISO 8601
|
||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||
|
||||
::
|
||||
|
||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||
|
||||
The ``±hh:mm`` value, if included, returns the time zone as an
|
||||
offset from UTC.
|
||||
|
||||
For example, ``2015-08-27T09:49:58-05:00``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
created_at_8:
|
||||
description: |
|
||||
The date and time stamp when the member was
|
||||
@ -1460,14 +1457,6 @@ force_delete_2:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
force_delete_3:
|
||||
description: |
|
||||
To force-delete a share, set this value to
|
||||
``null``. The force- delete action, unlike the delete action,
|
||||
ignores the share status.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
force_host_copy:
|
||||
description: |
|
||||
Enables or disables generic host-based forced
|
||||
@ -1640,12 +1629,6 @@ id_6:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id_7:
|
||||
description: |
|
||||
The access rule ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id_8:
|
||||
description: |
|
||||
The UUID of the access rule.
|
||||
@ -1914,12 +1897,6 @@ neutron_subnet_id_1:
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
new_size:
|
||||
description: |
|
||||
New size of the share, in GBs.
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
next-available:
|
||||
description: |
|
||||
The date and time stamp when next issues are available.
|
||||
@ -2572,6 +2549,14 @@ share_backend_name:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
share_force_delete:
|
||||
description: |
|
||||
To force-delete a share, set this value to
|
||||
``null``. The force-delete action, unlike the delete action,
|
||||
ignores the share status.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
share_id_1:
|
||||
description: |
|
||||
The ID of the share that is a consistency group
|
||||
@ -2593,13 +2578,6 @@ share_id_4:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
share_id_7:
|
||||
description: |
|
||||
The UUID of the share to which you are granted
|
||||
or denied access.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
share_instance_id_1:
|
||||
description: |
|
||||
The UUID of the share instance that owns this
|
||||
@ -2656,6 +2634,12 @@ share_network_name:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
share_new_size:
|
||||
description: |
|
||||
New size of the share, in GBs.
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
share_proto:
|
||||
description: |
|
||||
The Shared File Systems protocol. A valid value
|
||||
@ -2732,6 +2716,12 @@ share_types_1:
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
share_unmanage:
|
||||
description: |
|
||||
To unmanage a share, set this value to ``null``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
shrink:
|
||||
description: |
|
||||
The ``shrink`` object.
|
||||
@ -3028,13 +3018,6 @@ status_10:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
status_11:
|
||||
description: |
|
||||
The share status, which is ``creating``,
|
||||
``error``, ``available``, ``deleting``, or ``error_deleting``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
status_15:
|
||||
description: |
|
||||
The share server status, which is ``active``,
|
||||
@ -3047,7 +3030,7 @@ status_16:
|
||||
The share status, which is ``creating``,
|
||||
``error``, ``available``, ``deleting``, ``error_deleting``,
|
||||
``manage_starting``, ``manage_error``, ``unmanage_starting``,
|
||||
``unmanage_error``, ``unmanaged``, ``extending``,
|
||||
``unmanage_error``, ``unmanaged``, ``extend``,
|
||||
``extending_error``, ``shrinking``, ``shrinking_error``, or
|
||||
``shrinking_possible_data_loss_error``.
|
||||
in: body
|
||||
@ -3204,12 +3187,6 @@ unmanage:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
unmanage_1:
|
||||
description: |
|
||||
To unmanage a share, set this value to ``null``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
updated:
|
||||
description: |
|
||||
The date and time stamp when the extension was last updated.
|
||||
@ -3265,26 +3242,6 @@ updated_at_2:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
updated_at_3:
|
||||
description: |
|
||||
The date and time stamp when the access rule was updated.
|
||||
|
||||
The date and time stamp format is `ISO 8601
|
||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||
|
||||
::
|
||||
|
||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||
|
||||
The ``±hh:mm`` value, if included, returns the time zone as an
|
||||
offset from UTC.
|
||||
|
||||
For example, ``2015-08-27T09:49:58-05:00``.
|
||||
|
||||
If the access rule was never updated, this value is ``null``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
updated_at_5:
|
||||
description: |
|
||||
The date and time stamp when the service was updated.
|
||||
|
@ -79,7 +79,7 @@ Request
|
||||
- access_type: access_type
|
||||
- access_to: access_to
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -92,15 +92,15 @@ Response parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- share_id: share_id_7
|
||||
- created_at: created_at_6
|
||||
- updated_at: updated_at_3
|
||||
- access_type: access_type_2
|
||||
- access_to: access_to_1
|
||||
- share_id: access_share_id
|
||||
- created_at: access_rule_created_at
|
||||
- updated_at: access_rule_updated_at
|
||||
- access_type: access_type
|
||||
- access_to: access_to
|
||||
- access_key: access_key
|
||||
- access: access
|
||||
- access_level: access_level_2
|
||||
- id: id_7
|
||||
- access_level: access_level
|
||||
- id: access_rule_id
|
||||
|
||||
Response example
|
||||
----------------
|
||||
@ -128,7 +128,7 @@ Request
|
||||
- deny_access: deny_access
|
||||
- access_id: access_id
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -155,7 +155,7 @@ Request
|
||||
|
||||
- access_list: access_list
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -169,13 +169,13 @@ Response parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- access_type: access_type_1
|
||||
- access_type: access_type
|
||||
- access_key: access_key
|
||||
- access_to: access_to_1
|
||||
- access_to: access_to
|
||||
- access_level: access_level
|
||||
- state: state
|
||||
- access_list: access_list
|
||||
- id: id_8
|
||||
- id: access_rule_id
|
||||
|
||||
Response example
|
||||
----------------
|
||||
@ -204,9 +204,9 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- reset_status: reset_status
|
||||
- status: status_11
|
||||
- status: access_status
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -234,9 +234,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- force_delete: force_delete
|
||||
- force_delete: share_force_delete
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -262,9 +262,9 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- extend: extend
|
||||
- new_size: new_size
|
||||
- new_size: share_new_size
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -290,9 +290,9 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- shrink: shrink
|
||||
- new_size: new_size
|
||||
- new_size: share_new_size
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
@ -317,9 +317,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- unmanage: unmanage
|
||||
- unmanage: share_unmanage
|
||||
- share_id: share_id
|
||||
- tenant_id: tenant_id_1
|
||||
- tenant_id: tenant_id_path
|
||||
|
||||
Request example
|
||||
---------------
|
||||
|
Loading…
Reference in New Issue
Block a user