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

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

Fixed IPs (os-fixed-ips) (DEPRECATED)

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

.. warning::

These APIs are proxy calls to the Network service. Nova has

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

Better wording for micorversion 2.36 make it follow other descriptions, use start from to make it clear 2.36 is the first microversion deprecate those proxy Implements: blueprint api-ref-in-rst-ocata Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367

2016年12月10日 15:57:14 +08:00

instead. These will fail with a 404 starting from microversion 2.36.

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 data for a fixed IP, such as host name, CIDR, and address. Also,

Complete method verification of os-fixed-ips Verified the API document for os-fixed-ips with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: I60096911a7895d989e056958e175477987cc72f8

2016年05月06日 12:29:48 -04:00

reserves and releases a fixed IP address.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Show Fixed Ip 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-fixed-ips/{fixed_ip}

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 fixed IP address.

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-fixed-ips Verified the API document for os-fixed-ips with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: I60096911a7895d989e056958e175477987cc72f8

2016年05月06日 12:29:48 -04:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

api-ref: parameter verification os-fixed-ips Change-Id: I0140ee7e49ffa39be07fe3f9a6ad24123be2a723

2016年06月06日 15:49:15 -04:00

- fixed_ip: fixed_ip_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 os-fixed-ips Change-Id: I0140ee7e49ffa39be07fe3f9a6ad24123be2a723

2016年06月06日 15:49:15 -04:00

.. rest_parameters:: parameters.yaml

- fixed_ip: fixed_ip_obj

- address: ip_address

- cidr: cidr

- host: fixed_ip_host

- hostname: fixed_ip_hostname

Add reserved param for v2.4 v2.4 added 'reserved' param to fixed ip output, this patch added it into doc. Change-Id: I3be65d6aa5e36662cbb09f408124d0abb8bbfdf5 Implements: blueprint api-ref-in-rst-ocata

2016年09月09日 20:21:47 +08:00

- reserved: reserved_fixedip

api-ref: parameter verification os-fixed-ips Change-Id: I0140ee7e49ffa39be07fe3f9a6ad24123be2a723

2016年06月06日 15:49:15 -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 Fixed Ip 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 fixed, floating ips API This fix sample file path and some satatus code for -fixed ips -floating ips Part of bp:api-ref-in-rst Change-Id: I33341d67e678f70b1a4feb9b39a14f5ac81e8c65

2016年04月20日 11:05:26 +09:00

.. literalinclude:: ../../doc/api_samples/os-fixed-ips/fixedips-get-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

Reserve Or Release A Fixed Ip

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

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-fixed-ips/{fixed_ip}/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

Reserves or releases a fixed IP.

api-ref: parameter verification os-fixed-ips Change-Id: I0140ee7e49ffa39be07fe3f9a6ad24123be2a723

2016年06月06日 15:49:15 -04:00

To reserve a fixed IP address, specify ``reserve`` in the request body.

To release a fixed IP address, specify ``unreserve`` in the request body.

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-fixed-ips Verified the API document for os-fixed-ips with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: I60096911a7895d989e056958e175477987cc72f8

2016年05月06日 12:29:48 -04:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

api-ref: parameter verification os-fixed-ips Change-Id: I0140ee7e49ffa39be07fe3f9a6ad24123be2a723

2016年06月06日 15:49:15 -04:00

- fixed_ip: fixed_ip_path

- reserve: action_reserve

- unreserve: action_unreserve

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

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 Reserve Or Release A Fixed Ip: JSON request**

Fix sample file path for fixed, floating ips API This fix sample file path and some satatus code for -fixed ips -floating ips Part of bp:api-ref-in-rst Change-Id: I33341d67e678f70b1a4feb9b39a14f5ac81e8c65

2016年04月20日 11:05:26 +09:00

.. literalinclude:: ../../doc/api_samples/os-fixed-ips/fixedip-post-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

Example verification for os-fixed-ips.inc part of bp:api-ref-in-rst Change-Id: Ia8ef988aeefb57c270d9d686b97faa5a7247cb05

2016年06月29日 14:41:05 -07:00

There is no body content for the response of a successful POST operation.

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

85 lines 1.9 KiB PHP Raw Normal View History Unescape Escape

85 lines

1.9 KiB

PHP

Raw Normal View History