openstack/nova
Code Issues Proposed changes
2eb358cdce
nova/api-ref/source/os-networks.inc

305 lines
7.4 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 -*-
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
======================================
Publish proxy APIs deprecation in api ref doc As first step to deprecate the proxy APIs, this commit publish the deprecation of proxy APIs in api ref doc. Partially implements blueprint deprecate-api-proxies Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
2016-06-14 15:31:18 +09:00
Networks (os-networks) (DEPRECATED)
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01: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
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
.. warning::
This API was designed to work with ``nova-network`` which was deprecated in
the 14.0.0 (Newton) release and removed in the 21.0.0 (Ussuri) release. Some
features are proxied to the Network service (neutron) when appropriate, but
as with all translation proxies, this is far from perfect compatibility.
These APIs should be avoided in new applications in favor of `using
neutron directly`__. These will fail with a 404 starting from microversion
2.36. They were removed in the 21.0.0 (Ussuri) release.
Publish proxy APIs deprecation in api ref doc As first step to deprecate the proxy APIs, this commit publish the deprecation of proxy APIs in api ref doc. Partially implements blueprint deprecate-api-proxies Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
2016-06-14 15:31:18 +09:00
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
__ https://docs.openstack.org/api-ref/network/v2/#networks
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -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
Creates, lists, shows information for, and deletes networks.
Adds network to a project, disassociates a network from a project, and
disassociates a project from a network.
Associates host with and disassociates host from a network.
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
List Networks
=============
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 /os-networks
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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Lists networks for the project.
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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable all users 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
Normal response codes: 200
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Error response codes: unauthorized(401), forbidden(403)
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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example List Networks: 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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
.. literalinclude:: ../../doc/api_samples/os-networks/networks-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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Create Network
==============
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 /os-networks
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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Creates a network.
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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role or the
owner of the network 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
Normal response codes: 200
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410), 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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example Create Network: JSON request**
.. literalinclude:: ../../doc/api_samples/os-networks/network-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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example Create Network: 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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
.. literalinclude:: ../../doc/api_samples/os-networks/network-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
Add Network
===========
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 /os-networks/add
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
Adds a network to a project.
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role 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
Normal response codes: 202
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), 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
**Example Add Network: JSON request**
.. literalinclude:: ../../doc/api_samples/os-networks/network-add-req.json
: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
Show Network 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 /os-networks/{network_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 network.
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable all users 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
Normal response codes: 200
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04: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
- network_id: network_id
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
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 Network 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
.. literalinclude:: ../../doc/api_samples/os-networks/network-show-resp.json
:language: javascript
Delete Network
==============
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 /os-networks/{network_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
Deletes a network.
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role or the
owner of the network 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
Normal response codes: 202
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), gone(410)
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
- network_id: network_id
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 method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
There is no body content for the response of a successful DELETE query.
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Associate Host
==============
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 /os-networks/{network_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
Associates a network with a host.
Remove duplicate api ref for os-networks/actions This remove the duplicate entry of os-networks/actions api ref and add the action name in their content. Part of bp:api-ref-in-rst Change-Id: I3ca28793b6bcf390c8a2bfa1dfcf0213cf6bd428
2016-04-20 17:11:06 +09:00
Specify the ``associate_host`` action in the request body.
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role or the owner
of the network 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
Normal response codes: 202
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), 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
- network_id: network_id
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
- associate_host: associate_host
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-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example Associate Host to Network: JSON 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
Fix content and sample file for keypair, migration, networks This fix some content and sample file path for: -os-keypairs -os-migrations -os-networks Part of bp:api-ref-in-rst Change-Id: I6ae6d38207c5a9552bab9a42b2800449e4ad040a
2016-04-20 12:03:04 +09:00
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-associate-host-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 method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
There is no body content for the response of a successful POST query.
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Disassociate Network
====================
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 /os-networks/{network_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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Disassociates a network from a project. You can then reuse the network.
Specify the ``disassociate`` action in the request body.
Remove duplicate api ref for os-networks/actions This remove the duplicate entry of os-networks/actions api ref and add the action name in their content. Part of bp:api-ref-in-rst Change-Id: I3ca28793b6bcf390c8a2bfa1dfcf0213cf6bd428
2016-04-20 17:11:06 +09:00
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role or the
owner of the network 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
Normal response codes: 202
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), 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
- network_id: network_id
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example Disassociate Network: JSON 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
Enable all extension for all remaining sample tests As extensions options has been deprecated, API sample tests should run against all extension enable. This commit enables all extensions for all the remaining sample tests and remove extensions specific tests and sample files. Also remove extension setting specific logic from base test class along with TODOs. Partially implements blueprint api-sample-tests-with-all-extensions Change-Id: I66b593760789e5b3b92137a672246f8d91e44cba
2016-06-10 14:56:46 +09:00
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-disassociate-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 method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
There is no body content for the response of a successful POST query.
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Disassociate Host
=================
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 /os-networks/{network_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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Disassociates a host from a network.
Remove duplicate api ref for os-networks/actions This remove the duplicate entry of os-networks/actions api ref and add the action name in their content. Part of bp:api-ref-in-rst Change-Id: I3ca28793b6bcf390c8a2bfa1dfcf0213cf6bd428
2016-04-20 17:11:06 +09:00
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Specify the ``disassociate_host`` action in the request body.
Merge "Fix content and sample file for keypair, migration, networks"
2016-04-20 11:14:38 +00:00
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role or the
owner of the network 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
Normal response codes: 202
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), 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
- network_id: network_id
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example Disassociate Host from Network: JSON 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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-disassociate-host-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 method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
There is no body content for the response of a successful POST query.
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Disassociate Project
====================
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 /os-networks/{network_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
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Disassociates a project from a network.
Remove duplicate api ref for os-networks/actions This remove the duplicate entry of os-networks/actions api ref and add the action name in their content. Part of bp:api-ref-in-rst Change-Id: I3ca28793b6bcf390c8a2bfa1dfcf0213cf6bd428
2016-04-20 17:11:06 +09:00
Merge "Fix content and sample file for keypair, migration, networks"
2016-04-20 11:14:38 +00:00
Specify the ``disassociate_project`` action in the request body.
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
Policy defaults enable only users with the administrative role or the
owner of the network 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
Normal response codes: 202
Remove (most) '/os-networks' REST APIs Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-21 22:27:15 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), 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
- network_id: network_id
Complete method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
**Example Disassociate Project from Network: JSON 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
Fix content and sample file for keypair, migration, networks This fix some content and sample file path for: -os-keypairs -os-migrations -os-networks Part of bp:api-ref-in-rst Change-Id: I6ae6d38207c5a9552bab9a42b2800449e4ad040a
2016-04-20 12:03:04 +09:00
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-disassociate-project-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 method verification of os-networks Verified the API document with source for methods available and response codes used. Recorded HTTP methods to match wiki. Marked the associate/disassociate sections as deprecated (as they are nova-net only), and added some warnings in the docs about their use. Part of bp:api-ref-in-rst Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
2016-05-09 12:10:21 -04:00
There is no body content for the response of a successful POST query.
Copy Permalink