openstack
/
manila
Code Issues Proposed changes
Browse Source

Merge "[api-ref] Refactor share network documentation"

changes/37/426737/1
Jenkins 6 years ago committed by Gerrit Code Review
parent
604a95f0a6 6df2483a7b
commit
595a2bd73c
2 changed files with 112 additions and 107 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 121
      api-ref/source/parameters.yaml
  2. 98
      api-ref/source/share-networks.inc

121
api-ref/source/parameters.yaml
Unescape View File

@ -74,7 +74,7 @@ share_instance_id:
in: path
required: true
type: string
share_network_id:
share_network_id_path:
description: |
The UUID of the share network.
in: path
@ -1023,24 +1023,6 @@ consistency_groups:
in: body
required: true
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:
description: |
The date and time stamp when the consistency
@ -1141,12 +1123,6 @@ deny_access:
in: body
required: true
type: object
description:
description: |
The share network description.
in: body
required: true
type: string
description_1:
description: |
The consistency group snapshot description.
@ -1631,12 +1607,6 @@ host_9:
in: body
required: false
type: string
id:
description: |
The share network ID.
in: body
required: true
type: string
id_1:
description: |
The consistency group snapshot ID.
@ -2389,13 +2359,6 @@ security_service_id:
in: body
required: true
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:
description: |
The security service name.
@ -2693,6 +2656,36 @@ share_instance_id_1:
in: body
required: true
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:
description: |
The ID of a share network. Note that when using
@ -2737,8 +2730,38 @@ share_network_id_7:
type: string
share_network_name:
description: |
The name of a share network that is associated
with the share server.
The name of a share network.
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
required: true
type: string
@ -3318,24 +3341,6 @@ updated:
in: body
required: true
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:
description: |
The date and time stamp when the share instance export location was

98
api-ref/source/share-networks.inc
Unescape View File

@ -52,15 +52,15 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- tenant_id: tenant_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: id
- name: name
- id: share_network_id
- name: share_network_name
Response example
----------------
@ -85,14 +85,14 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- tenant_id: tenant_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: id
- id: share_network_id
- project_id: project_id
- neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id
@ -100,10 +100,10 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- name: share_network_name
- description: share_network_description
- created_at: share_network_created_at
- updated_at: share_network_updated_at
Response example
----------------
@ -128,15 +128,15 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- share_network_id: share_network_id
- tenant_id: tenant_id_path
- share_network_id: share_network_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: id
- id: share_network_id
- project_id: project_id
- neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id
@ -144,10 +144,10 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- name: share_network_name
- description: share_network_description
- created_at: share_network_created_at
- updated_at: share_network_updated_at
Response example
----------------
@ -173,11 +173,11 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- tenant_id: tenant_id_path
- neutron_net_id: neutron_net_id_1
- neutron_subnet_id: neutron_subnet_id_1
- name: name
- description: description
- name: share_network_name_request
- description: share_network_description
Request example
---------------
@ -190,7 +190,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id
- id: share_network_id
- project_id: project_id
- neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id
@ -198,10 +198,10 @@ Response parameters
- segmentation_id: segmentation_id_1
- cidr: cidr_1
- ip_version: ip_version_1
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- name: share_network_name
- description: share_network_description
- created_at: share_network_created_at
- updated_at: share_network_updated_at
Response example
----------------
@ -227,7 +227,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- share_network_id: share_network_id
- share_network_id: share_network_id_path
- security_service_id: security_service_id
Request example
@ -242,7 +242,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id
- id: share_network_id
- project_id: project_id
- neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id
@ -250,10 +250,10 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- name: share_network_name
- description: share_network_description
- created_at: share_network_created_at
- updated_at: share_network_updated_at
Response example
----------------
@ -280,9 +280,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- share_network_id: share_network_id
- security_service_id: security_service_id_2
- tenant_id: tenant_id_path
- share_network_id: share_network_id_path
- security_service_id: share_network_security_service_id
Request example
---------------
@ -295,7 +295,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id
- id: share_network_id
- project_id: project_id
- neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id
@ -303,10 +303,10 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- name: share_network_name
- description: share_network_description
- created_at: share_network_created_at
- updated_at: share_network_updated_at
Response example
----------------
@ -334,10 +334,10 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- share_network_id: share_network_id
- name: name
- description: description
- tenant_id: tenant_id_path
- share_network_id: share_network_id_path
- name: share_network_name_request
- description: share_network_description
Request example
---------------
@ -350,7 +350,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id
- id: share_network_id
- project_id: project_id
- neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id
@ -358,10 +358,10 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- name: share_network_name
- description: share_network_description
- created_at: share_network_created_at
- updated_at: share_network_updated_at
Response example
----------------
@ -386,5 +386,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- share_network_id: share_network_id
- tenant_id: tenant_id_path
- share_network_id: share_network_id_path

Write Preview
Loading…
Cancel
Save