openstack/manila
Code Issues Proposed changes

Merge "Api-ref: Add min_version in the API parameters"

Browse Source
This commit is contained in:
Zuul 2018-08-04 02:03:25 +00:00 committed by Gerrit Code Review
commit 65076ffba8
1 changed files with 27 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -389,10 +389,11 @@ share_server_id_query:
type: string type: string
share_type_id_2: share_type_id_2:
description: | description: |
(Since API v2.6) The UUID of the share type. The UUID of the share type.
in: query in: query
required: false required: false
type: string type: string
min_version: 2.6
share_type_query: share_type_query:
description: | description: |
The share type name or UUID. Allows filtering back end pools based The share type name or UUID. Allows filtering back end pools based
@ -654,10 +655,11 @@ allow_access:
type: object type: object
availability_zone: availability_zone:
description: | description: |
(Since API v2.1) The availability zone. The availability zone.
in: body in: body
required: false required: false
type: string type: string
min_version: 2.1
availability_zone_1: availability_zone_1:
description: | description: |
The availability zone. The availability zone.
@ -1466,11 +1468,11 @@ group_specs_required:
type: object type: object
has_replicas: has_replicas:
description: | description: |
(Since API v2.11) Indicates whether a share has Indicates whether a share has replicas or not.
replicas or not.
in: body in: body
required: true required: true
type: boolean type: boolean
min_version: 2.11
host_1: host_1:
description: | description: |
The share host name. The share host name.
@ -1631,12 +1633,13 @@ is_group_type_default:
min_version: 2.46 min_version: 2.46
is_public: is_public:
description: | description: |
(Since API v2.8) The level of visibility for the The level of visibility for the share. Set to ``true`` to make
share. Set to ``true`` to make share public. Set to ``false`` to share public. Set to ``false`` to make it private. Default value
make it private. Default value is ``false``. is ``false``.
in: body in: body
required: false required: false
type: boolean type: boolean
min_version: 2.8
link_1: link_1:
description: | description: |
The share links The share links
@ -2273,12 +2276,13 @@ remaining:
type: integer type: integer
replica_state: replica_state:
description: | description: |
(Since API v2.11) The share replica state. Has The share replica state. Has set value only when replication
set value only when replication is used. List of possible values: is used. List of possible values: ``active``, ``in_sync``,
``active``, ``in_sync``, ``out_of_sync``, and ``error``. ``out_of_sync``, and ``error``.
in: body in: body
required: true required: true
type: string type: string
min_version: 2.11
replication_type: replication_type:
description: | description: |
The share replication type. The share replication type.
@ -3074,11 +3078,12 @@ share_type:
type: string type: string
share_type_1: share_type_1:
description: | description: |
(Since API v2.6) The UUID of the share type. In The UUID of the share type. In minor versions, this parameter is
minor versions, this parameter is a share type name, as a string. a share type name, as a string.
in: body in: body
required: true required: true
type: string type: string
min_version: 2.6
share_type_2: share_type_2:
description: | description: |
The share type name. The share type name.
@ -3115,12 +3120,13 @@ share_type_id_body:
type: string type: string
share_type_name: share_type_name:
description: | description: |
(Since API v2.6) The share type name. Minor The share type name. Minor versions support only the
versions support only the ``share_type`` parameter where the share ``share_type`` parameter where the share type name is
type name is expected. expected.
in: body in: body
required: true required: true
type: string type: string
min_version: 2.6
share_types: share_types:
description: | description: |
A list of one or more share type IDs. A list of one or more share type IDs.
@ -3383,12 +3389,12 @@ snapshot_status_request:
type: string type: string
snapshot_support: snapshot_support:
description: | description: |
(Since API v2.2) An extra specification that An extra specification that filters back ends by whether
filters back ends by whether they do or do not support share they do or do not support share snapshots.
snapshots.
in: body in: body
required: true required: true
type: boolean type: boolean
min_version: 2.2
snapshot_support_1: snapshot_support_1:
description: | description: |
An extra specification that filters back ends by An extra specification that filters back ends by
@ -3545,9 +3551,8 @@ storage_protocol:
type: string type: string
task_state: task_state:
description: | description: |
(Since API v2.5) For the share migration, the For the share migration, the migration task state. A valid
migration task state. A valid value is ``null``, value is ``null``, ``migration_starting``, ``migration_error``,
``migration_starting``, ``migration_error``,
``migration_success``, ``migration_completing``, or ``migrating``. ``migration_success``, ``migration_completing``, or ``migrating``.
The ``task_state`` is ``null`` unless the share is migrated from The ``task_state`` is ``null`` unless the share is migrated from
one back-end to another. For details, see ``os-migrate_share`` one back-end to another. For details, see ``os-migrate_share``
@ -3555,6 +3560,7 @@ task_state:
in: body in: body
required: true required: true
type: string type: string
min_version: 2.5
timestamp: timestamp:
description: | description: |
The date and time stamp when the API request was issued. The date and time stamp when the API request was issued.