From 0c183948f4c0476ab7f90201e093008f3fcdf61f Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Thu, 12 May 2016 11:23:29 +0900 Subject: [PATCH] api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst --- api-ref/source/os-interface.inc | 46 ++++++++++++++++++++++----------- api-ref/source/parameters.yaml | 46 +++++++++++++++++++++++++-------- 2 files changed, 66 insertions(+), 26 deletions(-) diff --git a/api-ref/source/os-interface.inc b/api-ref/source/os-interface.inc index 839ecdfcf3bf..eba46e935e1f 100644 --- a/api-ref/source/os-interface.inc +++ b/api-ref/source/os-interface.inc @@ -1,5 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification .. needs:example_verification .. needs:body_verification @@ -29,19 +28,21 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id - - server_id: server_id + - server_id: server_id_path Response -------- .. rest_parameters:: parameters.yaml - - interfaceAttachment: interfaceAttachment + - interfaceAttachments: interfaceAttachments - port_state: port_state - - fixed_ips: fixed_ips + - fixed_ips: fixed_ips_resp + - ip_address: ip_address + - subnet_id: subnet_id - mac_addr: mac_addr - - net_id: net_id - - port_id: port_id + - net_id: net_id_resp + - port_id: port_id_resp **Example List Port Interfaces: JSON response** @@ -66,11 +67,12 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id - - server_id: server_id + - server_id: server_id_path - interfaceAttachment: interfaceAttachment - port_id: port_id - net_id: net_id - fixed_ips: fixed_ips + - ip_address: ip_address_req **Example Create Interface: JSON request** @@ -82,11 +84,13 @@ Response .. rest_parameters:: parameters.yaml - - interfaceAttachment: interfaceAttachment - - fixed_ips: fixed_ips + - interfaceAttachment: interfaceAttachment_resp + - fixed_ips: fixed_ips_resp + - ip_address: ip_address + - subnet_id: subnet_id - mac_addr: mac_addr - - net_id: net_id - - port_id: port_id + - net_id: net_id_resp + - port_id: port_id_resp - port_state: port_state **Example Create Interface: JSON response** @@ -111,12 +115,23 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id - - server_id: server_id - - port_id: port_id + - server_id: server_id_path + - port_id: port_id_path Response -------- +.. rest_parameters:: parameters.yaml + + - interfaceAttachment: interfaceAttachment_resp + - port_state: port_state + - fixed_ips: fixed_ips_resp + - ip_address: ip_address + - subnet_id: subnet_id + - mac_addr: mac_addr + - net_id: net_id_resp + - port_id: port_id_resp + **Example Show Port Interface Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-show-resp.json @@ -140,9 +155,10 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id - - server_id: server_id - - port_id: port_id + - server_id: server_id_path + - port_id: port_id_path Response -------- +No body is returned on successful request. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index e7883c1566c1..577eb3fe282b 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -184,7 +184,7 @@ node_id: in: path required: true type: string -port_id_1: +port_id_path: description: | The UUID of the port. in: path @@ -1099,17 +1099,11 @@ fixed_ip: type: string fixed_ips: description: | - Fixed IP addresses with subnet IDs. If you request a specific fixed IP address - without a ``net_id``, the request returns a ``Bad Request (400)`` response code. + Fixed IP addresses. If you request a specific fixed IP address without + a ``net_id``, the request returns a ``Bad Request (400)`` response code. in: body required: false type: array -fixed_ips_1: - description: | - Fixed IP addresses with subnet IDs. - in: body - required: true - type: array fixed_ips_quota: description: | The number of allowed fixed IP addresses for each tenant. Must be equal to or @@ -1131,6 +1125,12 @@ fixed_ips_quota_optional: in: body required: false type: integer +fixed_ips_resp: + description: | + Fixed IP addresses with subnet IDs. + in: body + required: true + type: array flavor: description: | The ID and links for the flavor for your server instance. A flavor is a combination @@ -1621,12 +1621,30 @@ interfaceAttachment: in: body required: true type: string +interfaceAttachment_resp: + description: | + The interface attachment. + in: body + required: true + type: object +interfaceAttachments: + description: | + List of the interface attachments. + in: body + required: true + type: array ip_address: description: | The IP address. in: body required: true type: string +ip_address_req: + description: | + The IP address. It is required when ``fixed_ips`` is specified. + in: body + required: true + type: string ip_protocol: description: | The IP protocol. A valid value is ICMP, TCP, or UDP. @@ -1839,7 +1857,7 @@ net_id: in: body required: false type: string -net_id_1: +net_id_resp: description: | The network ID. in: body @@ -2144,7 +2162,7 @@ port_id: in: body required: false type: string -port_id_2: +port_id_resp: description: | The port ID. in: body @@ -2589,6 +2607,12 @@ source_type: in: body required: true type: string +subnet_id: + description: | + The UUID of the subnet. + in: body + required: true + type: string suspend: description: | The action.