openstack/nova
Code Issues Proposed changes
8ad11697f9
nova/api-ref/source/os-interface.inc

176 lines
4.0 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 -*-
=========================================
Port interfaces (servers, os-interface)
=========================================
Body verification of os-interface.inc This patch verifies the body of os-interface.inc part of bp:api-ref-in-rst Change-Id: Ie7a127b66f1b740d5b6f4bd434b62a06af2a3209
2016-07-06 16:54:46 +08:00
List port interfaces, show port interface details of the given server.
Create a port interface and uses it to attach a port to the given server,
detach a port interface from the given server.
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
List Port Interfaces
====================
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 /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:: GET /servers/{server_id}/os-interface
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
Lists port interfaces that are attached to a server.
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: 200
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
NotImplemented(501)
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: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09: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
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
.. rest_parameters:: parameters.yaml
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- interfaceAttachments: interfaceAttachments
Complete Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
- port_state: port_state
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- fixed_ips: fixed_ips_resp
- ip_address: ip_address
- subnet_id: subnet_id
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
- mac_addr: mac_addr
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- net_id: net_id_resp
- port_id: port_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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
**Example List Port Interfaces: JSON response**
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-list-resp.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
Complete Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
Create Interface
================
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 /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}/os-interface
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
Body verification of os-interface.inc This patch verifies the body of os-interface.inc part of bp:api-ref-in-rst Change-Id: Ie7a127b66f1b740d5b6f4bd434b62a06af2a3209
2016-07-06 16:54:46 +08:00
Creates a port interface and uses it to attach a port to a server.
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: 200
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409), computeFault(500), NotImplemented(501)
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: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- server_id: server_id_path
Complete Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
- interfaceAttachment: interfaceAttachment
- port_id: port_id
- net_id: net_id
- fixed_ips: fixed_ips
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- ip_address: ip_address_req
API support for tagged device attachment This patch adds microversion 2.49, which supports tagged attachment of network interfaces and block devices. Change-Id: I8d3bbe7e9a21d2694d10ee89628deb333e6b0487 Implements: blueprint virt-device-tagged-attach-detach
2016-09-25 10:00:43 -04:00
- tag: device_tag_nic_attachment
Complete Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
**Example Create Interface: JSON request**
Body verification of os-interface.inc This patch verifies the body of os-interface.inc part of bp:api-ref-in-rst Change-Id: Ie7a127b66f1b740d5b6f4bd434b62a06af2a3209
2016-07-06 16:54:46 +08:00
Create interface with ``net_id`` and ``fixed_ips``.
api-ref: Example verification for os-interface.inc Add an example creating an interface with net_id and fixed_ips in addition to an example with port_id. The example and the sample test have been added in I6b2567db82d000e4b1cdf46020ce1b57103c3f46. Change-Id: Ia71ecf3dd633409f9bb5156c5e68f6bb878eee71 Implements: blueprint api-ref-in-rst
2016-05-24 11:32:12 +09:00
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-create-net_id-req.json
:language: javascript
Body verification of os-interface.inc This patch verifies the body of os-interface.inc part of bp:api-ref-in-rst Change-Id: Ie7a127b66f1b740d5b6f4bd434b62a06af2a3209
2016-07-06 16:54:46 +08:00
Create interface with ``port_id``.
api-ref: Example verification for os-interface.inc Add an example creating an interface with net_id and fixed_ips in addition to an example with port_id. The example and the sample test have been added in I6b2567db82d000e4b1cdf46020ce1b57103c3f46. Change-Id: Ia71ecf3dd633409f9bb5156c5e68f6bb878eee71 Implements: blueprint api-ref-in-rst
2016-05-24 11:32:12 +09:00
Complete Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-create-req.json
:language: javascript
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
API support for tagged device attachment This patch adds microversion 2.49, which supports tagged attachment of network interfaces and block devices. Change-Id: I8d3bbe7e9a21d2694d10ee89628deb333e6b0487 Implements: blueprint virt-device-tagged-attach-detach
2016-09-25 10:00:43 -04:00
**Example Create Tagged Interface (v2.49): JSON request**
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/v2.49/attach-interfaces-create-req.json
:language: javascript
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
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
.. rest_parameters:: parameters.yaml
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- interfaceAttachment: interfaceAttachment_resp
- fixed_ips: fixed_ips_resp
- ip_address: ip_address
- subnet_id: subnet_id
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
- mac_addr: mac_addr
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- net_id: net_id_resp
- port_id: port_id_resp
Complete Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
- port_state: port_state
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
**Example Create Interface: JSON response**
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-create-resp.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
Show Port Interface Details
===========================
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:: GET /servers/{server_id}/os-interface/{port_id}
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
Shows details for a port interface that is attached to a server.
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: 200
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
Error response codes: 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: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- server_id: server_id_path
- port_id: port_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
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
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
.. 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
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Show Port Interface Details: JSON response**
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 sample file path for os-i* API This patch fix sample files path for os-i* APIs Part of bp:api-ref-in-rst Change-Id: I0d8de9aaef7ffe5e0dfe09f38246b1f57ac814cb
2016-04-20 11:38:31 +09:00
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-show-resp.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
Detach Interface
================
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:: DELETE /servers/{server_id}/os-interface/{port_id}
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
Body verification of os-interface.inc This patch verifies the body of os-interface.inc part of bp:api-ref-in-rst Change-Id: Ie7a127b66f1b740d5b6f4bd434b62a06af2a3209
2016-07-06 16:54:46 +08:00
Detaches a port interface from a server.
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 Method Verification of os-interface verified the API doc for os-interface, changes sequence of POST/GET and remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
api-ref: Example verification for os-interface.inc Add an example creating an interface with net_id and fixed_ips in addition to an example with port_id. The example and the sample test have been added in I6b2567db82d000e4b1cdf46020ce1b57103c3f46. Change-Id: Ia71ecf3dd633409f9bb5156c5e68f6bb878eee71 Implements: blueprint api-ref-in-rst
2016-05-24 11:32:12 +09:00
conflict(409), NotImplemented(501)
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: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
- server_id: server_id_path
- port_id: port_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
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
api-ref: Parameter verification for os-interface.inc Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249 Implements: blueprint api-ref-in-rst
2016-05-12 11:23:29 +09:00
No body is returned on successful request.
Copy Permalink