Complete verification of servers-action-fixed-ip.inc

This includes the parameter, body, and example verifications for
api-ref servers-action-fixed-ip.

part of bp:api-ref-in-rst-pike

Change-Id: I2b9971d7ff3716f330b55020bf37489dbc9e9b2c
This commit is contained in:
stewie925
2016-07-06 16:39:11 -07:00
committed by stewie925
parent 5d9bfa0f4e
commit 5c574cf31c
3 changed files with 30 additions and 14 deletions

View File

@@ -819,10 +819,10 @@ action_unreserve:
type: string
addFixedIp:
description: |
The action.
The action to add a fixed ip address to a server.
in: body
required: true
type: string
type: object
addFloatingIp:
description: |
The action. Contains required floating IP ``address`` and optional
@@ -3724,10 +3724,10 @@ rebuild:
type: string
removeFixedIp:
description: |
The action.
The action to remove a fixed ip address from a server.
in: body
required: true
type: string
type: object
removeFloatingIp:
description: |
The action.

View File

@@ -1,11 +1,14 @@
.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
Add (Associate) Fixed Ip (Addfixedip Action)
Add (Associate) Fixed Ip (addFixedIp Action)
============================================
.. note::
Network APIs and proxies are deprecated beginning microversion 2.36, except
for actions on non-deprecated resources such as servers. The addFixedIp
action is one such exemption.
.. rest_method:: POST /servers/{server_id}/action
Adds a fixed IP address to a server instance, which associates that
@@ -20,7 +23,8 @@ can change these permissions through the ``policy.json`` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
@@ -29,8 +33,9 @@ Request
- server_id: server_id_path
- addFixedIp: addFixedIp
- networkId: net_id_resp
**Example Add (Associate) Fixed Ip (Addfixedip Action)**
**Example Add (Associate) Fixed Ip (addFixedIp Action)**
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
:language: javascript
@@ -38,10 +43,18 @@ Request
Response
--------
No response body is returned after a successful addFixedIp action.
Remove (Disassociate) Fixed Ip (Removefixedip Action)
Remove (Disassociate) Fixed Ip (removeFixedIp Action)
=====================================================
.. note::
Network APIs and proxies are deprecated as of microversion 2.36, except
for actions on non-deprecated resources such as servers. The removeFixedIp
action is one such exemption.
.. rest_method:: POST /servers/{server_id}/action
Removes, or disassociates, a fixed IP address from a server.
@@ -54,7 +67,8 @@ can change these permissions through the ``policy.json`` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
@@ -64,8 +78,9 @@ Request
- server_id: server_id_path
- removeFixedIp: removeFixedIp
- address: ip_address
**Example Remove (Disassociate) Fixed Ip (Removefixedip Action)**
**Example Remove (Disassociate) Fixed Ip (removeFixedIp Action)**
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
:language: javascript
@@ -73,3 +88,4 @@ Request
Response
--------
No response body is returned after a successful removeFixedIp action.

View File

@@ -2,4 +2,4 @@
"addFixedIp": {
"networkId": 1
}
}
}