openstack/manila
Code Issues Proposed changes

[api-ref] Refactor Manila security service API

Browse Source 
This patch make security service api reference to be more readable
and maintainable.

Change-Id: I802f09baee7dda91999983947aca8406a57d445e
This commit is contained in:
Ha Van Tu 2016-09-26 12:07:10 +07:00
parent 5c794d4f98
commit 9152425f2f
2 changed files with 235 additions and 230 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -50,7 +50,7 @@ export_location_id:
in: path in: path
required: false required: false
type: string type: string
security_service_id_1: security_service_id_path:
description: | description: |
The UUID of the security service. The UUID of the security service.
in: path in: path
@ -907,24 +907,6 @@ created_at_2:
in: body in: body
required: true required: true
type: string type: string
created_at_3:
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
created_at_4: created_at_4:
description: | description: |
The date and time stamp when the share was created. The date and time stamp when the share was created.
@ -1053,13 +1035,6 @@ description_11:
in: body in: body
required: true required: true
type: string type: string
description_12:
description: |
The security service description. If you specify
this value, the description is updated.
in: body
required: false
type: string
description_2: description_2:
description: | description: |
The consistency group description. The consistency group description.
@ -1184,32 +1159,6 @@ display_name_4:
in: body in: body
required: false required: false
type: string type: string
dns_ip:
description: |
The DNS IP address that is used inside the tenant
network.
in: body
required: false
type: string
dns_ip_1:
description: |
The DNS IP address that is used inside the tenant
network.
in: body
required: true
type: string
domain:
description: |
The security service domain.
in: body
required: false
type: string
domain_1:
description: |
The security service domain.
in: body
required: true
type: string
driver_handles_share_servers: driver_handles_share_servers:
description: | description: |
An extra specification that defines the driver An extra specification that defines the driver
@ -1564,12 +1513,6 @@ id_16:
in: body in: body
required: true required: true
type: string type: string
id_3:
description: |
The security service ID.
in: body
required: true
type: string
id_4: id_4:
description: | description: |
The UUID of the share. The UUID of the share.
@ -1770,12 +1713,6 @@ name_11:
in: body in: body
required: true required: true
type: string type: string
name_12:
description: |
The security service name.
in: body
required: true
type: string
name_14: name_14:
description: | description: |
The snapshot name. The snapshot name.
@ -1950,18 +1887,6 @@ os-share-type-access:is_public:
in: body in: body
required: false required: false
type: boolean type: boolean
password:
description: |
The user password, if you specify a ``user``.
in: body
required: false
type: string
password_1:
description: |
The user password, if you specify a ``user``.
in: body
required: true
type: string
path: path:
description: | description: |
The export location path that should be used for The export location path that should be used for
@ -2028,13 +1953,6 @@ project_id_2:
in: body in: body
required: true required: true
type: string type: string
project_id_3:
description: |
The UUID of the project where the security
service was created.
in: body
required: true
type: string
project_id_4: project_id_4:
description: | description: |
The UUID of the project in which the share was The UUID of the project in which the share was
@ -2219,10 +2137,66 @@ reset_status:
in: body in: body
required: true required: true
type: object type: object
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:
description: |
Description of the security service in plain text.
in: body
required: true
type: string
security_service_description_request:
description: |
The security service description. If you specify
this value, the description is updated.
in: body
required: false
type: string
security_service_dns_ip:
description: |
The DNS IP address that is used inside the tenant
network.
in: body
required: true
type: string
security_service_dns_ip_request:
description: |
The DNS IP address that is used inside the tenant
network.
in: body
required: false
type: string
security_service_domain:
description: |
The security service domain.
in: body
required: true
type: string
security_service_domain_request:
description: |
The security service domain.
in: body
required: false
type: string
security_service_id: security_service_id:
description: | description: |
The UUID of the security service to add to the The security service ID.
share network. For details, see the security service section.
in: body in: body
required: true required: true
type: string type: string
@ -2233,6 +2207,101 @@ security_service_id_2:
in: body in: body
required: true required: true
type: string type: string
security_service_name:
description: |
The security service name.
in: body
required: true
type: string
security_service_password:
description: |
The user password, if you specify a ``user``.
in: body
required: true
type: string
security_service_password_request:
description: |
The user password, if you specify a ``user``.
in: body
required: false
type: string
security_service_project_id:
description: |
The UUID of the project where the security
service was created.
in: body
required: true
type: string
security_service_server:
description: |
The security service host name or IP address.
in: body
required: true
type: string
security_service_server_request:
description: |
The security service host name or IP address.
in: body
required: false
type: string
security_service_status:
description: |
The security service status.
in: body
required: true
type: string
security_service_type:
description: |
The security service type. A valid value is
``ldap``, ``kerberos``, or ``active_directory``.
in: body
required: true
type: string
security_service_type_request:
description: |
The security service type. A valid value is
``ldap``, ``kerberos``, or ``active_directory``.
in: body
required: false
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:
description: |
The security service user or group name that is
used by the tenant.
in: body
required: true
type: string
security_service_user_request:
description: |
The security service user or group name that is
used by the tenant.
in: body
required: false
type: string
security_servie_server_request:
description: |
The security service host name or IP address.
in: body
required: false
type: string
segmentation_id: segmentation_id:
description: | description: |
The segmentation ID. The segmentation ID.
@ -2249,18 +2318,6 @@ segmentation_id_1:
in: body in: body
required: true required: true
type: integer type: integer
server:
description: |
The security service host name or IP address.
in: body
required: false
type: string
server_1:
description: |
The security service host name or IP address.
in: body
required: true
type: string
server_pools_mapping: server_pools_mapping:
description: | description: |
The mapping between servers and pools. The mapping between servers and pools.
@ -2797,12 +2854,6 @@ status_16:
in: body in: body
required: true required: true
type: string type: string
status_2:
description: |
The security service status.
in: body
required: true
type: string
status_3: status_3:
description: | description: |
The share status. A valid value is: - The share status. A valid value is: -
@ -2937,20 +2988,6 @@ totalSnapshotGigabytesUsed:
in: body in: body
required: true required: true
type: integer type: integer
type:
description: |
The security service type. A valid value is
``ldap``, ``kerberos``, or ``active_directory``.
in: body
required: true
type: string
type_1:
description: |
The security service type. A valid value is
``ldap``, ``kerberos``, or ``active_directory``.
in: body
required: false
type: string
unit: unit:
description: | description: |
The time interval during which a number of API The time interval during which a number of API
@ -3010,24 +3047,6 @@ updated_at:
in: body in: body
required: true required: true
type: string type: string
updated_at_1:
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
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
@ -3128,20 +3147,6 @@ uri:
in: body in: body
required: false required: false
type: string type: string
user:
description: |
The security service user or group name that is
used by the tenant.
in: body
required: false
type: string
user_1:
description: |
The security service user or group name that is
used by the tenant.
in: body
required: true
type: string
user_id: user_id:
description: | description: |
ID of the user that is part of a given tenant. ID of the user that is part of a given tenant.

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

@ -47,17 +47,17 @@ 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
- status: status_2 - status: security_service_status
- type: type - type: security_service_type
- id: id_3 - id: security_service_id
- name: name_12 - name: security_service_name
Response example Response example
---------------- ----------------
@ -81,26 +81,26 @@ 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
- status: status_2 - status: security_service_status
- id: id_3 - id: security_service_id
- project_id: project_id_3 - project_id: security_service_project_id
- type: type - type: security_service_type
- name: name_12 - name: security_service_name
- description: description_12 - description: security_service_description
- dns_ip: dns_ip - dns_ip: security_service_dns_ip
- user: user - user: security_service_user
- password: password - password: security_service_password
- domain: domain - domain: security_service_domain
- server: server - server: security_service_server
- updated_at: created_at_3 - updated_at: security_service_updated_at
- created_at: created_at_1 - created_at: security_service_created_at
Response example Response example
---------------- ----------------
@ -125,27 +125,27 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1 - tenant_id: tenant_id_path
- security_service_id: security_service_id_1 - security_service_id: security_service_id_path
Response parameters Response parameters
------------------- -------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: security_service_status
- id: id_3 - id: security_service_id
- project_id: project_id_3 - project_id: security_service_project_id
- type: type - type: security_service_type
- name: name_12 - name: security_service_name
- description: description_12 - description: security_service_description
- dns_ip: dns_ip - dns_ip: security_service_dns_ip
- user: user - user: security_service_user
- password: password - password: security_service_password
- domain: domain - domain: security_service_domain
- server: server - server: security_service_server
- updated_at: created_at_3 - updated_at: security_service_updated_at
- created_at: created_at_1 - created_at: security_service_created_at
Response example Response example
---------------- ----------------
@ -170,15 +170,15 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1 - tenant_id: tenant_id_path
- type: type - type: security_service_type
- name: name_12 - name: security_service_name
- description: description_12 - description: security_service_description_request
- dns_ip: dns_ip - dns_ip: security_service_dns_ip_request
- user: user - user: security_service_user_request
- password: password - password: security_service_password_request
- domain: domain - domain: security_service_domain_request
- server: server - server: security_service_server_request
Request example Request example
--------------- ---------------
@ -191,19 +191,19 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: security_service_status
- id: id_3 - id: security_service_id
- project_id: project_id_3 - project_id: security_service_project_id
- type: type - type: security_service_type
- name: name_12 - name: security_service_name
- description: description_12 - description: security_service_description
- dns_ip: dns_ip - dns_ip: security_service_dns_ip
- user: user - user: security_service_user
- password: password - password: security_service_password
- domain: domain - domain: security_service_domain
- server: server - server: security_service_server
- updated_at: created_at_3 - updated_at: security_service_updated_at
- created_at: created_at_1 - created_at: security_service_created_at
Response example Response example
---------------- ----------------
@ -233,16 +233,16 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1 - tenant_id: tenant_id_path
- security_service_id: security_service_id_1 - security_service_id: security_service_id_path
- type: type - type: security_service_type
- name: name_12 - name: security_service_name
- description: description_12 - description: security_service_description_request
- dns_ip: dns_ip - dns_ip: security_service_dns_ip_request
- user: user - user: security_service_user_request
- password: password - password: security_service_password_request
- domain: domain - domain: security_service_domain_request
- server: server - server: security_service_server_request
Request example Request example
--------------- ---------------
@ -255,19 +255,19 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: security_service_status
- id: id_3 - id: security_service_id
- project_id: project_id_3 - project_id: security_service_project_id
- type: type - type: security_service_type
- name: name_12 - name: security_service_name
- description: description_12 - description: security_service_description
- dns_ip: dns_ip - dns_ip: security_service_dns_ip
- user: user - user: security_service_user
- password: password - password: security_service_password
- domain: domain - domain: security_service_domain
- server: server - server: security_service_server
- updated_at: created_at_3 - updated_at: security_service_updated_at
- created_at: created_at_1 - created_at: security_service_created_at
Response example Response example
---------------- ----------------
@ -292,5 +292,5 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1 - tenant_id: tenant_id_path
- security_service_id: security_service_id_1 - security_service_id: security_service_id_path