From 9152425f2f00cce360c65db559c73780d686f93b Mon Sep 17 00:00:00 2001 From: Ha Van Tu Date: Mon, 26 Sep 2016 12:07:10 +0700 Subject: [PATCH] [api-ref] Refactor Manila security service API This patch make security service api reference to be more readable and maintainable. Change-Id: I802f09baee7dda91999983947aca8406a57d445e --- api-ref/source/parameters.yaml | 303 ++++++++++++++------------- api-ref/source/security-services.inc | 162 +++++++------- 2 files changed, 235 insertions(+), 230 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 87c92fdf96..d1254eb5fe 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -50,7 +50,7 @@ export_location_id: in: path required: false type: string -security_service_id_1: +security_service_id_path: description: | The UUID of the security service. in: path @@ -907,24 +907,6 @@ created_at_2: in: body required: true 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 - `_: - - :: - - 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: description: | The date and time stamp when the share was created. @@ -1053,13 +1035,6 @@ description_11: in: body required: true 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: | The consistency group description. @@ -1184,32 +1159,6 @@ display_name_4: in: body required: false 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: description: | An extra specification that defines the driver @@ -1564,12 +1513,6 @@ id_16: in: body required: true type: string -id_3: - description: | - The security service ID. - in: body - required: true - type: string id_4: description: | The UUID of the share. @@ -1770,12 +1713,6 @@ name_11: in: body required: true type: string -name_12: - description: | - The security service name. - in: body - required: true - type: string name_14: description: | The snapshot name. @@ -1950,18 +1887,6 @@ os-share-type-access:is_public: in: body required: false 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: description: | The export location path that should be used for @@ -2028,13 +1953,6 @@ project_id_2: in: body required: true 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: description: | The UUID of the project in which the share was @@ -2219,10 +2137,66 @@ reset_status: in: body required: true 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 + `_: + + :: + + 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: description: | - The UUID of the security service to add to the - share network. For details, see the security service section. + The security service ID. in: body required: true type: string @@ -2233,6 +2207,101 @@ security_service_id_2: in: body required: true 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 + `_: + + :: + + 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: description: | The segmentation ID. @@ -2249,18 +2318,6 @@ segmentation_id_1: in: body required: true 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: description: | The mapping between servers and pools. @@ -2797,12 +2854,6 @@ status_16: in: body required: true type: string -status_2: - description: | - The security service status. - in: body - required: true - type: string status_3: description: | The share status. A valid value is: - @@ -2937,20 +2988,6 @@ totalSnapshotGigabytesUsed: in: body required: true 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: description: | The time interval during which a number of API @@ -3010,24 +3047,6 @@ updated_at: in: body required: true 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 - `_: - - :: - - 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 @@ -3128,20 +3147,6 @@ uri: in: body required: false 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: description: | ID of the user that is part of a given tenant. diff --git a/api-ref/source/security-services.inc b/api-ref/source/security-services.inc index 9fc93ae6bf..701b937905 100644 --- a/api-ref/source/security-services.inc +++ b/api-ref/source/security-services.inc @@ -47,17 +47,17 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id_1 + - tenant_id: tenant_id_path Response parameters ------------------- .. rest_parameters:: parameters.yaml - - status: status_2 - - type: type - - id: id_3 - - name: name_12 + - status: security_service_status + - type: security_service_type + - id: security_service_id + - name: security_service_name Response example ---------------- @@ -81,26 +81,26 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id_1 + - tenant_id: tenant_id_path Response parameters ------------------- .. rest_parameters:: parameters.yaml - - status: status_2 - - id: id_3 - - project_id: project_id_3 - - type: type - - name: name_12 - - description: description_12 - - dns_ip: dns_ip - - user: user - - password: password - - domain: domain - - server: server - - updated_at: created_at_3 - - created_at: created_at_1 + - status: security_service_status + - id: security_service_id + - project_id: security_service_project_id + - type: security_service_type + - name: security_service_name + - description: security_service_description + - dns_ip: security_service_dns_ip + - user: security_service_user + - password: security_service_password + - domain: security_service_domain + - server: security_service_server + - updated_at: security_service_updated_at + - created_at: security_service_created_at Response example ---------------- @@ -125,27 +125,27 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id_1 - - security_service_id: security_service_id_1 + - tenant_id: tenant_id_path + - security_service_id: security_service_id_path Response parameters ------------------- .. rest_parameters:: parameters.yaml - - status: status_2 - - id: id_3 - - project_id: project_id_3 - - type: type - - name: name_12 - - description: description_12 - - dns_ip: dns_ip - - user: user - - password: password - - domain: domain - - server: server - - updated_at: created_at_3 - - created_at: created_at_1 + - status: security_service_status + - id: security_service_id + - project_id: security_service_project_id + - type: security_service_type + - name: security_service_name + - description: security_service_description + - dns_ip: security_service_dns_ip + - user: security_service_user + - password: security_service_password + - domain: security_service_domain + - server: security_service_server + - updated_at: security_service_updated_at + - created_at: security_service_created_at Response example ---------------- @@ -170,15 +170,15 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id_1 - - type: type - - name: name_12 - - description: description_12 - - dns_ip: dns_ip - - user: user - - password: password - - domain: domain - - server: server + - tenant_id: tenant_id_path + - type: security_service_type + - name: security_service_name + - description: security_service_description_request + - dns_ip: security_service_dns_ip_request + - user: security_service_user_request + - password: security_service_password_request + - domain: security_service_domain_request + - server: security_service_server_request Request example --------------- @@ -191,19 +191,19 @@ Response parameters .. rest_parameters:: parameters.yaml - - status: status_2 - - id: id_3 - - project_id: project_id_3 - - type: type - - name: name_12 - - description: description_12 - - dns_ip: dns_ip - - user: user - - password: password - - domain: domain - - server: server - - updated_at: created_at_3 - - created_at: created_at_1 + - status: security_service_status + - id: security_service_id + - project_id: security_service_project_id + - type: security_service_type + - name: security_service_name + - description: security_service_description + - dns_ip: security_service_dns_ip + - user: security_service_user + - password: security_service_password + - domain: security_service_domain + - server: security_service_server + - updated_at: security_service_updated_at + - created_at: security_service_created_at Response example ---------------- @@ -233,16 +233,16 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id_1 - - security_service_id: security_service_id_1 - - type: type - - name: name_12 - - description: description_12 - - dns_ip: dns_ip - - user: user - - password: password - - domain: domain - - server: server + - tenant_id: tenant_id_path + - security_service_id: security_service_id_path + - type: security_service_type + - name: security_service_name + - description: security_service_description_request + - dns_ip: security_service_dns_ip_request + - user: security_service_user_request + - password: security_service_password_request + - domain: security_service_domain_request + - server: security_service_server_request Request example --------------- @@ -255,19 +255,19 @@ Response parameters .. rest_parameters:: parameters.yaml - - status: status_2 - - id: id_3 - - project_id: project_id_3 - - type: type - - name: name_12 - - description: description_12 - - dns_ip: dns_ip - - user: user - - password: password - - domain: domain - - server: server - - updated_at: created_at_3 - - created_at: created_at_1 + - status: security_service_status + - id: security_service_id + - project_id: security_service_project_id + - type: security_service_type + - name: security_service_name + - description: security_service_description + - dns_ip: security_service_dns_ip + - user: security_service_user + - password: security_service_password + - domain: security_service_domain + - server: security_service_server + - updated_at: security_service_updated_at + - created_at: security_service_created_at Response example ---------------- @@ -292,5 +292,5 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id_1 - - security_service_id: security_service_id_1 + - tenant_id: tenant_id_path + - security_service_id: security_service_id_path