openstack/nova
Code Issues Proposed changes
74db119220
nova/api-ref/source/servers-action-fixed-ip.inc

92 lines
2.5 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
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
2016-07-06 16:39:11 -07:00
Add (Associate) Fixed Ip (addFixedIp Action)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
============================================
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
2016-07-06 16:39:11 -07:00
.. 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.
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: POST /servers/{server_id}/action
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
method verification for servers-action-fixed-ip Verify and Update the response codes for the methods based on what is in the code. part of blueprint: api-ref-in-rst Change-Id: I08d4cbf17fdc0efa42efe9beaa0012ca92320b09
2016-05-10 19:56:35 +00:00
Adds a fixed IP address to a server instance, which associates that
address with the server. The fixed IP address is retrieved from the
network that you specify in the request.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Specify the ``addFixedIp`` action and the network ID in the request body.
method verification for servers-action-fixed-ip Verify and Update the response codes for the methods based on what is in the code. part of blueprint: api-ref-in-rst Change-Id: I08d4cbf17fdc0efa42efe9beaa0012ca92320b09
2016-05-10 19:56:35 +00:00
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Remove 40X and 50X from Normal response codes HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
2016-04-18 16:41:58 -07:00
Normal response codes: 202
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-07-06 16:39:11 -07:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
- addFixedIp: addFixedIp
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
2016-07-06 16:39:11 -07:00
- networkId: net_id_resp
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-07-06 16:39:11 -07:00
**Example Add (Associate) Fixed Ip (addFixedIp Action)**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix all remaining sample file path This patch fix sample file path in all remaining api ref files. Part of bp:api-ref-in-rst Change-Id: I214b3a5bedea44cdfeba644ef3796938b709f4bf
2016-04-20 16:56:47 +09:00
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-07-06 16:39:11 -07:00
No response body is returned after a successful addFixedIp action.
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
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
2016-07-06 16:39:11 -07:00
Remove (Disassociate) Fixed Ip (removeFixedIp Action)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
=====================================================
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
2016-07-06 16:39:11 -07:00
.. 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.
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: POST /servers/{server_id}/action
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Removes, or disassociates, a fixed IP address from a server.
Specify the ``removeFixedIp`` action in the request body.
method verification for servers-action-fixed-ip Verify and Update the response codes for the methods based on what is in the code. part of blueprint: api-ref-in-rst Change-Id: I08d4cbf17fdc0efa42efe9beaa0012ca92320b09
2016-05-10 19:56:35 +00:00
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Remove 40X and 50X from Normal response codes HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
2016-04-18 16:41:58 -07:00
Normal response codes: 202
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-07-06 16:39:11 -07:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
- removeFixedIp: removeFixedIp
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
2016-07-06 16:39:11 -07:00
- address: ip_address
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-07-06 16:39:11 -07:00
**Example Remove (Disassociate) Fixed Ip (removeFixedIp Action)**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix all remaining sample file path This patch fix sample file path in all remaining api ref files. Part of bp:api-ref-in-rst Change-Id: I214b3a5bedea44cdfeba644ef3796938b709f4bf
2016-04-20 16:56:47 +09:00
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-07-06 16:39:11 -07:00
No response body is returned after a successful removeFixedIp action.
Copy Permalink