openstack/manila
Code Issues Proposed changes

[api-ref] De-duplicate date and time parameters

Browse Source 
Many APIs present information when the resource
in question was 'created_at' and 'updated_at'.

Having common parameters is easier to maintain in
the documentation since the description is the same
across the board.

Change-Id: Ia5d4ac399fe0d7983c61f5c5e0245d0987e97d6a
Partial-Bug: #1760644
This commit is contained in:
Goutham Pacha Ravi 2019-03-28 14:56:08 -07:00
parent d7140ffe09
commit f185ff0f44
20 changed files with 84 additions and 523 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/availability-zones.inc
View File

@ -48,8 +48,8 @@ Response parameters
- availability_zones: availability_zones - availability_zones: availability_zones
- id: availability_zone_id - id: availability_zone_id
- name: availability_zone_name - name: availability_zone_name
- created_at: availability_zone_created_at - created_at: created_at
- updated_at: availability_zone_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

2
api-ref/source/extensions.inc
View File

@ -43,7 +43,7 @@ Response parameters
- links: extension_links - links: extension_links
- description: extension_description - description: extension_description
- alias: extension_alias - alias: extension_alias
- updated: extension_updated - updated: updated_at_extensions
Response example Response example
---------------- ----------------

2
api-ref/source/os-share-manage.inc
View File

@ -91,7 +91,7 @@ Response parameters
- is_public: is_public - is_public: is_public
- snapshot_support: snapshot_support - snapshot_support: snapshot_support
- name: name_5 - name: name_5
- created_at: created_at_4 - created_at: created_at
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - volume_type: volume_type

459
api-ref/source/parameters.yaml
View File

@ -569,50 +569,12 @@ access_metadata:
in: body in: body
required: true required: true
type: object type: object
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: access_rule_id:
description: | description: |
The access rule ID. The access rule ID.
in: body in: body
required: true required: true
type: string 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: access_rules_status:
description: | description: |
The share instance access rules status. A valid value is ``active``, The share instance access rules status. A valid value is ``active``,
@ -710,24 +672,6 @@ availability_zone_1:
in: body in: body
required: true required: true
type: string type: string
availability_zone_created_at:
description: |
The date and time stamp when the availability zone 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
availability_zone_id: availability_zone_id:
description: | description: |
The availability zone ID. The availability zone ID.
@ -747,24 +691,6 @@ availability_zone_name:
in: body in: body
required: true required: true
type: string type: string
availability_zone_updated_at:
description: |
The date and time stamp when the availability zone 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
availability_zones: availability_zones:
description: | description: |
Top level response body element. Top level response body element.
@ -972,9 +898,10 @@ create_share_from_snapshot_support:
required: false required: false
type: boolean type: boolean
min_version: 2.24 min_version: 2.24
created_at_4: created_at:
description: | description: |
The date and time stamp when the share was created. The date and time stamp when the resource was created within the service's
database.
The date and time stamp format is `ISO 8601 The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_: <https://en.wikipedia.org/wiki/ISO_8601>`_:
@ -986,62 +913,7 @@ created_at_4:
The ``±hh:mm`` value, if included, returns the time zone as an The ``±hh:mm`` value, if included, returns the time zone as an
offset from UTC. offset from UTC.
For example, ``2015-08-27T09:49:58-05:00``. For example, ``2019-03-27T09:49:58-05:00``.
in: body
required: true
type: string
created_at_5:
description: |
The date and time stamp when the share instance export location 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, ``2016-12-31T13:14:15-05:00``.
in: body
required: true
type: string
created_at_9:
description: |
The date and time stamp when the share instance 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_share_server_body:
description: |
The date and time stamp when the share server was created or managed.
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
@ -1221,25 +1093,6 @@ export_location_availability_zone:
in: body in: body
required: true required: true
type: string type: string
export_location_created_at:
description: |
The date and time stamp when the share export location 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, ``2016-12-31T13:14:15-05:00``.
in: body
required: true
type: string
export_location_id: export_location_id:
description: | description: |
The share export location UUID. The share export location UUID.
@ -1288,25 +1141,6 @@ export_location_share_instance_id:
in: body in: body
required: true required: true
type: string type: string
export_location_updated_at:
description: |
The date and time stamp when the share export location 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, ``2016-12-31T13:14:15-05:00``.
in: body
required: true
type: string
export_locations: export_locations:
description: | description: |
A list of export locations. For example, when a share server A list of export locations. For example, when a share server
@ -1361,24 +1195,6 @@ extension_name:
in: body in: body
required: true required: true
type: string type: string
extension_updated:
description: |
The date and time stamp when the extension was last 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
extra_spec_key: extra_spec_key:
description: | description: |
The extra specification key The extra specification key
@ -1434,24 +1250,6 @@ free_capacity_gb:
in: body in: body
required: true required: true
type: string type: string
group_snapshot_created_at:
description: |
The date and time stamp when the share group snapshot 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
group_snapshot_description: group_snapshot_description:
description: | description: |
The share group snapshot description. The share group snapshot description.
@ -2402,24 +2200,6 @@ revert_to_snapshot_support:
required: false required: false
type: boolean type: boolean
min_version: 2.27 min_version: 2.27
security_service_created_at:
description: |
The date and time stamp when the security service 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
security_service_description: security_service_description:
description: | description: |
Description of the security service in plain text. Description of the security service in plain text.
@ -2528,24 +2308,6 @@ security_service_type_request:
in: body in: body
required: false required: false
type: string type: string
security_service_updated_at:
description: |
The date and time stamp when the security service 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
security_service_user: security_service_user:
description: | description: |
The security service user or group name that is used by the project. The security service user or group name that is used by the project.
@ -2688,24 +2450,6 @@ service_status_response:
in: body in: body
required: true required: true
type: string type: string
service_updated_at:
description: |
The date and time stamp when the service 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
service_zone_response: service_zone_response:
description: | description: |
The service availability zone. The service availability zone.
@ -2738,25 +2482,6 @@ share_force_delete:
in: body in: body
required: true required: true
type: string type: string
share_group_created_at:
description: |
The date and time stamp when the share group 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, ``2016-12-31T13:14:15-05:00``.
in: body
required: true
type: string
share_group_description: share_group_description:
description: | description: |
The share group description. The share group description.
@ -2869,24 +2594,6 @@ 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: share_network_description:
description: | description: |
The share network description. The share network description.
@ -2974,24 +2681,6 @@ share_network_security_service_id:
in: body in: body
required: true required: true
type: string 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
share_new_size: share_new_size:
description: | description: |
New size of the share, in GBs. New size of the share, in GBs.
@ -3028,24 +2717,6 @@ share_replica_cast_rules_to_readonly:
required: true required: true
type: string type: string
min_version: 2.30 min_version: 2.30
share_replica_created_at:
description: |
The date and time stamp when the share replica 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_replica_force_delete: share_replica_force_delete:
description: | description: |
To force-delete a share replica, set this value to To force-delete a share replica, set this value to
@ -3100,24 +2771,6 @@ share_replica_status:
in: body in: body
required: true required: true
type: string type: string
share_replica_updated_at:
description: |
The date and time stamp when the share replica 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
share_server_id: share_server_id:
description: | description: |
The UUID of the share server. The UUID of the share server.
@ -3157,24 +2810,6 @@ share_server_unmanage:
in: body in: body
required: true required: true
type: object type: object
share_server_updated_at:
description: |
The date and time stamp when the share server 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
share_size_1: share_size_1:
description: | description: |
The size of a source share, in GBs. The size of a source share, in GBs.
@ -3286,25 +2921,6 @@ size_2:
in: body in: body
required: true required: true
type: integer type: integer
snapshot_created_at:
description: |
The date and time stamp when the snapshot or snapshot instance 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
snapshot_description: snapshot_description:
description: | description: |
The snapshot description. The snapshot description.
@ -3382,25 +2998,6 @@ snapshot_instance_status:
in: body in: body
required: true required: true
type: string type: string
snapshot_instance_updated_at:
description: |
The date and time stamp when the snapshot instance 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, ``2016-12-31T13:14:15-05:00``.
in: body
required: true
type: string
snapshot_manage_share_id: snapshot_manage_share_id:
description: | description: |
The UUID of the share that has snapshot which The UUID of the share that has snapshot which
@ -3766,28 +3363,11 @@ unmanage:
in: body in: body
required: true required: true
type: string type: string
updated: updated_at:
description: | description: |
The date and time stamp when the extension was last updated. The date and time stamp when the resource was last updated within the
service's database. If a resource was never updated after it was
The date and time stamp format is `ISO 8601 created, the value of this parameter is set to ``null``.
<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
updated.
The date and time stamp format is `ISO 8601 The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_: <https://en.wikipedia.org/wiki/ISO_8601>`_:
@ -3803,33 +3383,14 @@ updated_at_2:
in: body in: body
required: true required: true
type: string type: string
updated_at_5: updated_at_extensions:
description: | description: |
The date and time stamp when the service was updated. The date and time stamp when the extension API was last updated.
The date and time stamp format is `ISO 8601 The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/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_share_server_body:
description: |
The date and time stamp when the share server 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 CCYY-MM-DDThh:mm:ss±hh:mm
The ``±hh:mm`` value, if included, returns the time zone as an The ``±hh:mm`` value, if included, returns the time zone as an

16
api-ref/source/security-services.inc
View File

@ -125,8 +125,8 @@ Response parameters
- domain: security_service_domain - domain: security_service_domain
- ou: security_service_ou - ou: security_service_ou
- server: security_service_server - server: security_service_server
- updated_at: security_service_updated_at - updated_at: updated_at
- created_at: security_service_created_at - created_at: created_at
Response example Response example
---------------- ----------------
@ -181,8 +181,8 @@ Response parameters
- domain: security_service_domain - domain: security_service_domain
- ou: security_service_ou - ou: security_service_ou
- server: security_service_server - server: security_service_server
- updated_at: security_service_updated_at - updated_at: updated_at
- created_at: security_service_created_at - created_at: created_at
Response example Response example
---------------- ----------------
@ -251,8 +251,8 @@ Response parameters
- domain: security_service_domain - domain: security_service_domain
- ou: security_service_ou - ou: security_service_ou
- server: security_service_server - server: security_service_server
- updated_at: security_service_updated_at - updated_at: updated_at
- created_at: security_service_created_at - created_at: created_at
Response example Response example
---------------- ----------------
@ -328,8 +328,8 @@ Response parameters
- domain: security_service_domain - domain: security_service_domain
- ou: security_service_ou - ou: security_service_ou
- server: security_service_server - server: security_service_server
- updated_at: security_service_updated_at - updated_at: updated_at
- created_at: security_service_created_at - created_at: created_at
Response example Response example
---------------- ----------------

2
api-ref/source/services.inc
View File

@ -57,7 +57,7 @@ Response parameters
- zone: service_zone_response - zone: service_zone_response
- host: service_host_response - host: service_host_response
- state: service_state_response - state: service_state_response
- updated_at: service_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

8
api-ref/source/share-access-rules.inc
View File

@ -45,8 +45,8 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share_id: access_share_id - share_id: access_share_id
- created_at: access_rule_created_at - created_at: created_at
- updated_at: access_rule_updated_at - updated_at: updated_at
- access_type: access_type - access_type: access_type
- access_to: access_to - access_to: access_to
- access_key: access_key - access_key: access_key
@ -112,8 +112,8 @@ Response parameters
- state: state - state: state
- access_list: access_list - access_list: access_list
- id: access_rule_id - id: access_rule_id
- created_at: access_rule_created_at - created_at: created_at
- updated_at: access_rule_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

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

@ -113,8 +113,8 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share_id: access_share_id - share_id: access_share_id
- created_at: access_rule_created_at - created_at: created_at
- updated_at: access_rule_updated_at - updated_at: updated_at
- access_type: access_type - access_type: access_type
- access_to: access_to - access_to: access_to
- access_key: access_key - access_key: access_key
@ -229,8 +229,8 @@ Response parameters
- state: state - state: state
- access_list: access_list - access_list: access_list
- id: access_rule_id - id: access_rule_id
- created_at: access_rule_created_at - created_at: created_at
- updated_at: access_rule_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

4
api-ref/source/share-export-locations.inc
View File

@ -103,8 +103,8 @@ Response parameters
- path: export_location_path - path: export_location_path
- is_admin_only: export_location_is_admin_only - is_admin_only: export_location_is_admin_only
- preferred: export_location_preferred - preferred: export_location_preferred
- created_at: export_location_created_at - created_at: created_at
- updated_at: export_location_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

10
api-ref/source/share-group-snapshots.inc
View File

@ -123,7 +123,7 @@ Response parameters
- share_group_id: share_group_id - share_group_id: share_group_id
- name: group_snapshot_name - name: group_snapshot_name
- description: group_snapshot_description - description: group_snapshot_description
- created_at: group_snapshot_created_at - created_at: created_at
- members: group_snapshot_members - members: group_snapshot_members
- links: group_snapshot_links - links: group_snapshot_links
@ -169,7 +169,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: group_snapshot_id - id: group_snapshot_id
- created_at: snapshot_created_at - created_at: created_at
- project_id: project_id - project_id: project_id
- size: snapshot_size - size: snapshot_size
- share_protocol: snapshot_share_protocol - share_protocol: snapshot_share_protocol
@ -226,7 +226,7 @@ Response parameters
- share_group_id: share_group_id - share_group_id: share_group_id
- name: group_snapshot_name - name: group_snapshot_name
- description: group_snapshot_description - description: group_snapshot_description
- created_at: group_snapshot_created_at - created_at: created_at
- members: group_snapshot_members - members: group_snapshot_members
- links: group_snapshot_links - links: group_snapshot_links
@ -288,7 +288,7 @@ Response parameters
- share_group_id: share_group_id - share_group_id: share_group_id
- name: group_snapshot_name - name: group_snapshot_name
- description: group_snapshot_description - description: group_snapshot_description
- created_at: group_snapshot_created_at - created_at: created_at
- members: group_snapshot_members - members: group_snapshot_members
- links: group_snapshot_links - links: group_snapshot_links
@ -392,7 +392,7 @@ Response parameters
- share_group_id: share_group_id - share_group_id: share_group_id
- name: group_snapshot_name - name: group_snapshot_name
- description: group_snapshot_description - description: group_snapshot_description
- created_at: group_snapshot_created_at - created_at: created_at
- members: group_snapshot_members - members: group_snapshot_members
- links: group_snapshot_links - links: group_snapshot_links

6
api-ref/source/share-groups.inc
View File

@ -124,7 +124,7 @@ Response parameters
- id: share_group_id - id: share_group_id
- name: share_group_name_response - name: share_group_name_response
- created_at: share_group_created_at - created_at: created_at
- status: share_group_status - status: share_group_status
- description: share_group_description_response - description: share_group_description_response
- project_id: project_id - project_id: project_id
@ -196,7 +196,7 @@ Response parameters
- id: share_group_id - id: share_group_id
- name: share_group_name_response - name: share_group_name_response
- created_at: share_group_created_at - created_at: created_at
- status: share_group_status - status: share_group_status
- description: share_group_description_response - description: share_group_description_response
- project_id: project_id - project_id: project_id
@ -308,7 +308,7 @@ Response parameters
- id: share_group_id - id: share_group_id
- name: share_group_name_response - name: share_group_name_response
- created_at: share_group_created_at - created_at: created_at
- status: share_group_status - status: share_group_status
- description: share_group_description_response - description: share_group_description_response
- project_id: project_id - project_id: project_id

4
api-ref/source/share-instance-export-locations.inc
View File

@ -101,8 +101,8 @@ Response parameters
- path: export_location_path - path: export_location_path
- is_admin_only: export_location_is_admin_only - is_admin_only: export_location_is_admin_only
- preferred: export_location_preferred - preferred: export_location_preferred
- created_at: export_location_created_at - created_at: created_at
- updated_at: export_location_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

4
api-ref/source/share-instances.inc
View File

@ -49,7 +49,7 @@ Response parameters
- access_rules_status: access_rules_status - access_rules_status: access_rules_status
- share_id: share_id_2 - share_id: share_id_2
- availability_zone: availability_zone_1 - availability_zone: availability_zone_1
- created_at: created_at_5 - created_at: created_at
- replica_state: replica_state - replica_state: replica_state
- export_location: export_location - export_location: export_location
- export_locations: export_locations - export_locations: export_locations
@ -106,7 +106,7 @@ Response parameters
- access_rules_status: access_rules_status - access_rules_status: access_rules_status
- share_id: share_id_2 - share_id: share_id_2
- availability_zone: availability_zone_1 - availability_zone: availability_zone_1
- created_at: created_at_5 - created_at: created_at
- replica_state: replica_state - replica_state: replica_state
- export_location: export_location - export_location: export_location
- export_locations: export_locations - export_locations: export_locations

24
api-ref/source/share-networks.inc
View File

@ -128,8 +128,8 @@ Response parameters
- ip_version: ip_version - ip_version: ip_version
- name: share_network_name - name: share_network_name
- description: share_network_description - description: share_network_description
- created_at: share_network_created_at - created_at: created_at
- updated_at: share_network_updated_at - updated_at: updated_at
- gateway: share_network_gateway - gateway: share_network_gateway
- mtu: share_network_mtu - mtu: share_network_mtu
@ -184,8 +184,8 @@ Response parameters
- ip_version: ip_version - ip_version: ip_version
- name: share_network_name - name: share_network_name
- description: share_network_description - description: share_network_description
- created_at: share_network_created_at - created_at: created_at
- updated_at: share_network_updated_at - updated_at: updated_at
- gateway: share_network_gateway - gateway: share_network_gateway
- mtu: share_network_mtu - mtu: share_network_mtu
@ -251,8 +251,8 @@ Response parameters
- ip_version: ip_version_1 - ip_version: ip_version_1
- name: share_network_name - name: share_network_name
- description: share_network_description - description: share_network_description
- created_at: share_network_created_at - created_at: created_at
- updated_at: share_network_updated_at - updated_at: updated_at
- gateway: share_network_gateway - gateway: share_network_gateway
- mtu: share_network_mtu - mtu: share_network_mtu
@ -316,8 +316,8 @@ Response parameters
- ip_version: ip_version - ip_version: ip_version
- name: share_network_name - name: share_network_name
- description: share_network_description - description: share_network_description
- created_at: share_network_created_at - created_at: created_at
- updated_at: share_network_updated_at - updated_at: updated_at
- gateway: share_network_gateway - gateway: share_network_gateway
- mtu: share_network_mtu - mtu: share_network_mtu
@ -381,8 +381,8 @@ Response parameters
- ip_version: ip_version - ip_version: ip_version
- name: share_network_name - name: share_network_name
- description: share_network_description - description: share_network_description
- created_at: share_network_created_at - created_at: created_at
- updated_at: share_network_updated_at - updated_at: updated_at
- gateway: share_network_gateway - gateway: share_network_gateway
- mtu: share_network_mtu - mtu: share_network_mtu
@ -451,8 +451,8 @@ Response parameters
- ip_version: ip_version - ip_version: ip_version
- name: share_network_name - name: share_network_name
- description: share_network_description - description: share_network_description
- created_at: share_network_created_at - created_at: created_at
- updated_at: share_network_updated_at - updated_at: updated_at
- gateway: share_network_gateway - gateway: share_network_gateway
- mtu: share_network_mtu - mtu: share_network_mtu

4
api-ref/source/share-replica-export-locations.inc
View File

@ -100,8 +100,8 @@ Response parameters
- preferred: export_location_preferred_replicas - preferred: export_location_preferred_replicas
- availability_zone: export_location_availability_zone - availability_zone: export_location_availability_zone
- replica_state: share_replica_replica_state - replica_state: share_replica_replica_state
- created_at: export_location_created_at - created_at: created_at
- updated_at: export_location_updated_at - updated_at: updated_at
Response example Response example
---------------- ----------------

12
api-ref/source/share-replicas.inc
View File

@ -99,13 +99,13 @@ Response parameters
- share_id: share_replica_share_id - share_id: share_replica_share_id
- status: share_replica_status - status: share_replica_status
- cast_rules_to_readonly: share_replica_cast_rules_to_readonly - cast_rules_to_readonly: share_replica_cast_rules_to_readonly
- updated_at: share_replica_updated_at - updated_at: updated_at
- share_network_id: share_network_id - share_network_id: share_network_id
- share_server_id: share_server_id - share_server_id: share_server_id
- host: share_replica_host - host: share_replica_host
- id: share_replica_id - id: share_replica_id
- replica_state: share_replica_replica_state - replica_state: share_replica_replica_state
- created_at: share_replica_created_at - created_at: created_at
Response example Response example
@ -266,13 +266,13 @@ Response parameters
- share_id: share_replica_share_id - share_id: share_replica_share_id
- status: share_replica_status - status: share_replica_status
- cast_rules_to_readonly: share_replica_cast_rules_to_readonly - cast_rules_to_readonly: share_replica_cast_rules_to_readonly
- updated_at: share_replica_updated_at - updated_at: updated_at
- share_network_id: share_network_id - share_network_id: share_network_id
- share_server_id: share_server_id - share_server_id: share_server_id
- host: share_replica_host - host: share_replica_host
- id: share_replica_id - id: share_replica_id
- replica_state: share_replica_replica_state - replica_state: share_replica_replica_state
- created_at: share_replica_created_at - created_at: created_at
Response example Response example
---------------- ----------------
@ -321,13 +321,13 @@ Response parameters
- share_id: share_replica_share_id - share_id: share_replica_share_id
- status: share_replica_status - status: share_replica_status
- cast_rules_to_readonly: share_replica_cast_rules_to_readonly - cast_rules_to_readonly: share_replica_cast_rules_to_readonly
- updated_at: share_replica_updated_at - updated_at: updated_at
- share_network_id: share_network_id - share_network_id: share_network_id
- share_server_id: share_server_id - share_server_id: share_server_id
- host: share_replica_host - host: share_replica_host
- id: share_replica_id - id: share_replica_id
- replica_state: share_replica_replica_state - replica_state: share_replica_replica_state
- created_at: share_replica_created_at - created_at: created_at
Response example Response example
---------------- ----------------

10
api-ref/source/share-servers.inc
View File

@ -78,7 +78,7 @@ Response parameters
- share_network_id: share_network_id - share_network_id: share_network_id
- share_network_name: share_network_name - share_network_name: share_network_name
- host: host_share_server_body - host: host_share_server_body
- updated_at: updated_at_share_server_body - updated_at: updated_at
Response example Response example
---------------- ----------------
@ -128,8 +128,8 @@ Response parameters
- share_network_id: share_network_id_share_server_body - share_network_id: share_network_id_share_server_body
- share_network_name: share_network_name - share_network_name: share_network_name
- host: host_share_server_body - host: host_share_server_body
- created_at: created_at_share_server_body - created_at: created_at
- updated_at: updated_at_share_server_body - updated_at: updated_at
- identifier: share_server_show_identifier - identifier: share_server_show_identifier
- is_auto_deletable: share_server_show_is_auto_deletable - is_auto_deletable: share_server_show_is_auto_deletable
@ -266,12 +266,12 @@ Response parameters
- id: share_server_id - id: share_server_id
- project_id: project_id - project_id: project_id
- updated_at: share_server_updated_at - updated_at: updated_at
- status: share_server_status - status: share_server_status
- host: manage_host - host: manage_host
- share_network_name: share_network_name - share_network_name: share_network_name
- share_network_id: share_network_id - share_network_id: share_network_id
- created_at: created_at_share_server_body - created_at: created_at
- backend_details: backend_details - backend_details: backend_details
- is_auto_deletable: is_auto_deletable - is_auto_deletable: is_auto_deletable
- identifier: identifier - identifier: identifier

10
api-ref/source/shares.inc
View File

@ -228,7 +228,7 @@ Response parameters
- name: name_5 - name: name_5
- has_replicas: has_replicas - has_replicas: has_replicas
- replication_type: replication_type - replication_type: replication_type
- created_at: created_at_4 - created_at: created_at
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - volume_type: volume_type
- count: count - count: count
@ -299,7 +299,7 @@ Response parameters
- name: name_5 - name: name_5
- has_replicas: has_replicas - has_replicas: has_replicas
- replication_type: replication_type - replication_type: replication_type
- created_at: created_at_4 - created_at: created_at
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - volume_type: volume_type
@ -392,7 +392,7 @@ Response parameters
- task_state: task_state - task_state: task_state
- share_server_id: share_server_id - share_server_id: share_server_id
- snapshot_support: snapshot_support - snapshot_support: snapshot_support
- created_at: created_at_4 - created_at: created_at
Response example Response example
---------------- ----------------
@ -488,7 +488,7 @@ Response parameters
- share_group_id: share_group_id - share_group_id: share_group_id
- snapshot_support: snapshot_support - snapshot_support: snapshot_support
- name: name_5 - name: name_5
- created_at: created_at_4 - created_at: created_at
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - volume_type: volume_type
@ -579,7 +579,7 @@ Response parameters
- name: name_5 - name: name_5
- has_replicas: has_replicas - has_replicas: has_replicas
- replication_type: replication_type - replication_type: replication_type
- created_at: created_at_4 - created_at: created_at
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - volume_type: volume_type

8
api-ref/source/snapshot-instances.inc
View File

@ -99,8 +99,8 @@ Response parameters
- id: snapshot_instance_id_response - id: snapshot_instance_id_response
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- created_at: snapshot_created_at - created_at: created_at
- updated_at: snapshot_instance_updated_at - updated_at: updated_at
- status: snapshot_instance_status - status: snapshot_instance_status
- share_id: share_id - share_id: share_id
- share_instance_id: share_instance_id_1 - share_instance_id: share_instance_id_1
@ -152,8 +152,8 @@ Response parameters
- id: snapshot_instance_id_response - id: snapshot_instance_id_response
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- created_at: snapshot_created_at - created_at: created_at
- updated_at: snapshot_instance_updated_at - updated_at: updated_at
- status: snapshot_instance_status - status: snapshot_instance_status
- share_id: share_id - share_id: share_id
- share_instance_id: share_instance_id_1 - share_instance_id: share_instance_id_1

10
api-ref/source/snapshots.inc
View File

@ -122,7 +122,7 @@ Response parameters
- share_id: snapshot_share_id - share_id: snapshot_share_id
- name: snapshot_name - name: snapshot_name
- description: snapshot_description - description: snapshot_description
- created_at: snapshot_created_at - created_at: created_at
- share_proto: snapshot_share_protocol - share_proto: snapshot_share_protocol
- share_size: snapshot_share_size - share_size: snapshot_share_size
- size: snapshot_size - size: snapshot_size
@ -174,7 +174,7 @@ Response parameters
- share_id: snapshot_share_id - share_id: snapshot_share_id
- name: snapshot_name - name: snapshot_name
- description: snapshot_description - description: snapshot_description
- created_at: snapshot_created_at - created_at: created_at
- share_proto: snapshot_share_protocol - share_proto: snapshot_share_protocol
- share_size: snapshot_share_size - share_size: snapshot_share_size
- size: snapshot_size - size: snapshot_size
@ -240,7 +240,7 @@ Response parameters
- status: snapshot_status - status: snapshot_status
- name: snapshot_name - name: snapshot_name
- description: snapshot_description - description: snapshot_description
- created_at: snapshot_created_at - created_at: created_at
- share_proto: snapshot_share_protocol - share_proto: snapshot_share_protocol
- share_size: snapshot_share_size - share_size: snapshot_share_size
- provider_location: snapshot_provider_location - provider_location: snapshot_provider_location
@ -315,7 +315,7 @@ Response parameters
- status: snapshot_manage_status - status: snapshot_manage_status
- name: snapshot_name - name: snapshot_name
- description: snapshot_description - description: snapshot_description
- created_at: snapshot_created_at - created_at: created_at
- share_proto: snapshot_share_protocol - share_proto: snapshot_share_protocol
- share_size: snapshot_share_size - share_size: snapshot_share_size
- provider_location: snapshot_provider_location - provider_location: snapshot_provider_location
@ -519,7 +519,7 @@ Response parameters
- share_id: snapshot_share_id - share_id: snapshot_share_id
- name: snapshot_name - name: snapshot_name
- description: snapshot_description - description: snapshot_description
- created_at: snapshot_created_at - created_at: created_at
- share_proto: snapshot_share_protocol - share_proto: snapshot_share_protocol
- share_size: snapshot_share_size - share_size: snapshot_share_size
- size: snapshot_size - size: snapshot_size