openstack/nova - nova - OpenDev: Free Software Needs Free Tools

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 -*-

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

======================================================

Floating IP pools (os-floating-ip-pools) (DEPRECATED)

======================================================

.. warning::

Update API reference for os-floating-ip-pools The os-floating-ip-pools API is implemented for both nova-network and neutron. When using neutron, it justs lists external network names. Since it's a deprecated proxy to neutron we won't remove it as part of blueprint remove-nova-network, but we can update the API reference to explain how to achieve the equivalent functionality in the networking service API, so that's done here. Change-Id: Ieb4c7a0657929f66ed5b642c5941e65aee24372d

2018年06月26日 09:47:23 -04:00

This API is a proxy call to the Network service. Nova has

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

deprecated all the proxy APIs and users should use the native APIs

Update API reference for os-floating-ip-pools The os-floating-ip-pools API is implemented for both nova-network and neutron. When using neutron, it justs lists external network names. Since it's a deprecated proxy to neutron we won't remove it as part of blueprint remove-nova-network, but we can update the API reference to explain how to achieve the equivalent functionality in the networking service API, so that's done here. Change-Id: Ieb4c7a0657929f66ed5b642c5941e65aee24372d

2018年06月26日 09:47:23 -04:00

instead. This API will fail with a 404 starting from microversion 2.36.

For the equivalent functionality in the Network service, one can request::

GET /networks?router:external=True&fields=name

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

Manages groups of floating IPs.

List Floating Ip Pools

======================

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-floating-ip-pools

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

Lists floating IP pools.

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

Policy defaults enable only users with the administrative role or user

who is authorized to operate on tenant <tenant_id> to perform this

operation. Cloud providers can change these permissions through the

api-ref verify os-floating-ip-pools.inc verified the API doc for os-floating-ip-pools, adjus the wording for 'owner' of the server, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Id8bd213282bc53f1f9fbc24d1d2b03ea135c376e

2016年04月24日 07:35:03 +08:00

``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

api-ref verify os-floating-ip-pools.inc verified the API doc for os-floating-ip-pools, adjus the wording for 'owner' of the server, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Id8bd213282bc53f1f9fbc24d1d2b03ea135c376e

2016年04月24日 07:35:03 +08: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

.. rest_parameters:: parameters.yaml

- floating_ip_pools: floating_ip_pools

nova-net: Update API reference guide As highlighted in I77b1cfeab3c00c6c3d7743ba51e12414806b71d2, filtering either floating IPs or floating IP pools by floating IP name will actually fallback to filtering by ID. Update the API ref to reflect this. Change-Id: I00443ae111cbd1e1ec4d2c2ae1828ddaa095fd1a Signed-off-by: Stephen Finucane <sfinucan@redhat.com>

2020年01月22日 13:50:30 +00:00

- name: floating_ip_pool_name_or_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

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 List Floating Ip Pools: 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-floating-ip-pools/floatingippools-list-resp.json

:language: javascript

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

47 lines 1.3 KiB PHP Raw Normal View History Unescape Escape

47 lines

1.3 KiB

PHP

Raw Normal View History