Merge "[api-ref] Refactor share network documentation"
This commit is contained in:
commit
595a2bd73c
@ -74,7 +74,7 @@ share_instance_id:
|
|||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
share_network_id:
|
share_network_id_path:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the share network.
|
The UUID of the share network.
|
||||||
in: path
|
in: path
|
||||||
@ -1023,24 +1023,6 @@ consistency_groups:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: array
|
type: array
|
||||||
created_at:
|
|
||||||
description: |
|
|
||||||
The date and time stamp when the share network 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_1:
|
created_at_1:
|
||||||
description: |
|
description: |
|
||||||
The date and time stamp when the consistency
|
The date and time stamp when the consistency
|
||||||
@ -1141,12 +1123,6 @@ deny_access:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
description:
|
|
||||||
description: |
|
|
||||||
The share network description.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
description_1:
|
description_1:
|
||||||
description: |
|
description: |
|
||||||
The consistency group snapshot description.
|
The consistency group snapshot description.
|
||||||
@ -1631,12 +1607,6 @@ host_9:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
id:
|
|
||||||
description: |
|
|
||||||
The share network ID.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
id_1:
|
id_1:
|
||||||
description: |
|
description: |
|
||||||
The consistency group snapshot ID.
|
The consistency group snapshot ID.
|
||||||
@ -2389,13 +2359,6 @@ security_service_id:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
security_service_id_2:
|
|
||||||
description: |
|
|
||||||
The UUID of the security service to remove from
|
|
||||||
the share network. For details, see the security service section.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
security_service_name:
|
security_service_name:
|
||||||
description: |
|
description: |
|
||||||
The security service name.
|
The security service name.
|
||||||
@ -2693,6 +2656,36 @@ share_instance_id_1:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
share_network_created_at:
|
||||||
|
description: |
|
||||||
|
The date and time stamp when the share network 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
|
||||||
|
share_network_description:
|
||||||
|
description: |
|
||||||
|
The share network description.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
share_network_id:
|
||||||
|
description: |
|
||||||
|
The share network ID.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
share_network_id_1:
|
share_network_id_1:
|
||||||
description: |
|
description: |
|
||||||
The ID of a share network. Note that when using
|
The ID of a share network. Note that when using
|
||||||
@ -2737,8 +2730,38 @@ share_network_id_7:
|
|||||||
type: string
|
type: string
|
||||||
share_network_name:
|
share_network_name:
|
||||||
description: |
|
description: |
|
||||||
The name of a share network that is associated
|
The name of a share network.
|
||||||
with the share server.
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
share_network_name_request:
|
||||||
|
description: |
|
||||||
|
The name of a share network.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
share_network_security_service_id:
|
||||||
|
description: |
|
||||||
|
The UUID of the security service to remove from
|
||||||
|
the share network. For details, see the security service section.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
share_network_updated_at:
|
||||||
|
description: |
|
||||||
|
The date and time stamp when the share network 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``.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
@ -3318,24 +3341,6 @@ updated:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
updated_at:
|
|
||||||
description: |
|
|
||||||
The date and time stamp when the share network 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``.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
updated_at_2:
|
updated_at_2:
|
||||||
description: |
|
description: |
|
||||||
The date and time stamp when the share instance export location was
|
The date and time stamp when the share instance export location was
|
||||||
|
@ -52,15 +52,15 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
|
|
||||||
Response parameters
|
Response parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- name: name
|
- name: share_network_name
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -85,14 +85,14 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
|
|
||||||
Response parameters
|
Response parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- neutron_net_id: neutron_net_id
|
- neutron_net_id: neutron_net_id
|
||||||
- neutron_subnet_id: neutron_subnet_id
|
- neutron_subnet_id: neutron_subnet_id
|
||||||
@ -100,10 +100,10 @@ Response parameters
|
|||||||
- segmentation_id: segmentation_id
|
- segmentation_id: segmentation_id
|
||||||
- cidr: cidr
|
- cidr: cidr
|
||||||
- ip_version: ip_version
|
- ip_version: ip_version
|
||||||
- name: name
|
- name: share_network_name
|
||||||
- description: description
|
- description: share_network_description
|
||||||
- created_at: created_at
|
- created_at: share_network_created_at
|
||||||
- updated_at: updated_at
|
- updated_at: share_network_updated_at
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -128,15 +128,15 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
- share_network_id: share_network_id
|
- share_network_id: share_network_id_path
|
||||||
|
|
||||||
Response parameters
|
Response parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- neutron_net_id: neutron_net_id
|
- neutron_net_id: neutron_net_id
|
||||||
- neutron_subnet_id: neutron_subnet_id
|
- neutron_subnet_id: neutron_subnet_id
|
||||||
@ -144,10 +144,10 @@ Response parameters
|
|||||||
- segmentation_id: segmentation_id
|
- segmentation_id: segmentation_id
|
||||||
- cidr: cidr
|
- cidr: cidr
|
||||||
- ip_version: ip_version
|
- ip_version: ip_version
|
||||||
- name: name
|
- name: share_network_name
|
||||||
- description: description
|
- description: share_network_description
|
||||||
- created_at: created_at
|
- created_at: share_network_created_at
|
||||||
- updated_at: updated_at
|
- updated_at: share_network_updated_at
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -173,11 +173,11 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
- neutron_net_id: neutron_net_id_1
|
- neutron_net_id: neutron_net_id_1
|
||||||
- neutron_subnet_id: neutron_subnet_id_1
|
- neutron_subnet_id: neutron_subnet_id_1
|
||||||
- name: name
|
- name: share_network_name_request
|
||||||
- description: description
|
- description: share_network_description
|
||||||
|
|
||||||
Request example
|
Request example
|
||||||
---------------
|
---------------
|
||||||
@ -190,7 +190,7 @@ Response parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- neutron_net_id: neutron_net_id
|
- neutron_net_id: neutron_net_id
|
||||||
- neutron_subnet_id: neutron_subnet_id
|
- neutron_subnet_id: neutron_subnet_id
|
||||||
@ -198,10 +198,10 @@ Response parameters
|
|||||||
- segmentation_id: segmentation_id_1
|
- segmentation_id: segmentation_id_1
|
||||||
- cidr: cidr_1
|
- cidr: cidr_1
|
||||||
- ip_version: ip_version_1
|
- ip_version: ip_version_1
|
||||||
- name: name
|
- name: share_network_name
|
||||||
- description: description
|
- description: share_network_description
|
||||||
- created_at: created_at
|
- created_at: share_network_created_at
|
||||||
- updated_at: updated_at
|
- updated_at: share_network_updated_at
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -227,7 +227,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- tenant_id: tenant_id
|
||||||
- share_network_id: share_network_id
|
- share_network_id: share_network_id_path
|
||||||
- security_service_id: security_service_id
|
- security_service_id: security_service_id
|
||||||
|
|
||||||
Request example
|
Request example
|
||||||
@ -242,7 +242,7 @@ Response parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- neutron_net_id: neutron_net_id
|
- neutron_net_id: neutron_net_id
|
||||||
- neutron_subnet_id: neutron_subnet_id
|
- neutron_subnet_id: neutron_subnet_id
|
||||||
@ -250,10 +250,10 @@ Response parameters
|
|||||||
- segmentation_id: segmentation_id
|
- segmentation_id: segmentation_id
|
||||||
- cidr: cidr
|
- cidr: cidr
|
||||||
- ip_version: ip_version
|
- ip_version: ip_version
|
||||||
- name: name
|
- name: share_network_name
|
||||||
- description: description
|
- description: share_network_description
|
||||||
- created_at: created_at
|
- created_at: share_network_created_at
|
||||||
- updated_at: updated_at
|
- updated_at: share_network_updated_at
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -280,9 +280,9 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
- share_network_id: share_network_id
|
- share_network_id: share_network_id_path
|
||||||
- security_service_id: security_service_id_2
|
- security_service_id: share_network_security_service_id
|
||||||
|
|
||||||
Request example
|
Request example
|
||||||
---------------
|
---------------
|
||||||
@ -295,7 +295,7 @@ Response parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- neutron_net_id: neutron_net_id
|
- neutron_net_id: neutron_net_id
|
||||||
- neutron_subnet_id: neutron_subnet_id
|
- neutron_subnet_id: neutron_subnet_id
|
||||||
@ -303,10 +303,10 @@ Response parameters
|
|||||||
- segmentation_id: segmentation_id
|
- segmentation_id: segmentation_id
|
||||||
- cidr: cidr
|
- cidr: cidr
|
||||||
- ip_version: ip_version
|
- ip_version: ip_version
|
||||||
- name: name
|
- name: share_network_name
|
||||||
- description: description
|
- description: share_network_description
|
||||||
- created_at: created_at
|
- created_at: share_network_created_at
|
||||||
- updated_at: updated_at
|
- updated_at: share_network_updated_at
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -334,10 +334,10 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
- share_network_id: share_network_id
|
- share_network_id: share_network_id_path
|
||||||
- name: name
|
- name: share_network_name_request
|
||||||
- description: description
|
- description: share_network_description
|
||||||
|
|
||||||
Request example
|
Request example
|
||||||
---------------
|
---------------
|
||||||
@ -350,7 +350,7 @@ Response parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id
|
- id: share_network_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- neutron_net_id: neutron_net_id
|
- neutron_net_id: neutron_net_id
|
||||||
- neutron_subnet_id: neutron_subnet_id
|
- neutron_subnet_id: neutron_subnet_id
|
||||||
@ -358,10 +358,10 @@ Response parameters
|
|||||||
- segmentation_id: segmentation_id
|
- segmentation_id: segmentation_id
|
||||||
- cidr: cidr
|
- cidr: cidr
|
||||||
- ip_version: ip_version
|
- ip_version: ip_version
|
||||||
- name: name
|
- name: share_network_name
|
||||||
- description: description
|
- description: share_network_description
|
||||||
- created_at: created_at
|
- created_at: share_network_created_at
|
||||||
- updated_at: updated_at
|
- updated_at: share_network_updated_at
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -386,5 +386,5 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id_1
|
- tenant_id: tenant_id_path
|
||||||
- share_network_id: share_network_id
|
- share_network_id: share_network_id_path
|
||||||
|
Loading…
Reference in New Issue
Block a user