api-ref: Add Networking v2.0 API versions response parameters
This patch adds Networking v2.0 API Versions response parameters http://developer.openstack.org/api-ref/networking/v2/#list-api-versions Change-Id: Ia6d5a9bdec2ee65ae9f6632625415447619f7a8f Partially-Implements: blueprint neutron-in-tree-api-ref
This commit is contained in:
parent
b06a428ff7
commit
6a73e976b0
@ -3046,6 +3046,42 @@ remote_ip_prefix_2:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
resource-collection:
|
||||||
|
description: |
|
||||||
|
Collection name of the resource.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
resource-href:
|
||||||
|
description: |
|
||||||
|
Link to the resource.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
resource-links:
|
||||||
|
description: |
|
||||||
|
List of links related to the resource. Each link is a dict with 'href' and 'rel'.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: array
|
||||||
|
resource-name:
|
||||||
|
description: |
|
||||||
|
Name of the the resource.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
resource-rel:
|
||||||
|
description: |
|
||||||
|
Relationship between link and the resource.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
resources:
|
||||||
|
description: |
|
||||||
|
List of resource objects.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: array
|
||||||
route_mode:
|
route_mode:
|
||||||
description: |
|
description: |
|
||||||
The route mode. A valid value is ``static``,
|
The route mode. A valid value is ``static``,
|
||||||
@ -4223,6 +4259,42 @@ value_1:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
|
version-href:
|
||||||
|
description: |
|
||||||
|
Link to the API.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
version-id:
|
||||||
|
description: |
|
||||||
|
Version of the API.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
version-links:
|
||||||
|
description: |
|
||||||
|
List of version links. Each link is a dict with 'href' and 'rel'.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: array
|
||||||
|
version-rel:
|
||||||
|
description: |
|
||||||
|
Relationship of link with the version.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
version-status:
|
||||||
|
description: |
|
||||||
|
Status of the API, which can be ``CURRENT``, ``STABLE`` or ``DEPRECATED``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
versions:
|
||||||
|
description: |
|
||||||
|
List of versions.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: array
|
||||||
vip:
|
vip:
|
||||||
description: |
|
description: |
|
||||||
A ``vip`` object.
|
A ``vip`` object.
|
||||||
|
@ -1,8 +1,5 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
.. needs:method_verification
|
|
||||||
.. needs:parameter_verification
|
|
||||||
.. needs:example_verification
|
.. needs:example_verification
|
||||||
.. needs:body_verification
|
|
||||||
|
|
||||||
============
|
============
|
||||||
API versions
|
API versions
|
||||||
@ -10,17 +7,15 @@ API versions
|
|||||||
|
|
||||||
Lists information for all Networking API versions.
|
Lists information for all Networking API versions.
|
||||||
|
|
||||||
Show API v2 details
|
List API versions
|
||||||
===================
|
=================
|
||||||
|
|
||||||
.. rest_method:: GET /v2.0
|
.. rest_method:: GET /
|
||||||
|
|
||||||
Shows details for Networking API v2.0.
|
Lists information about all Networking API versions.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: 203
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -31,32 +26,49 @@ Response Parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- location: location
|
- versions: versions
|
||||||
|
- status: version-status
|
||||||
Response Example
|
- id: version-id
|
||||||
----------------
|
- links: version-links
|
||||||
|
- href: version-href
|
||||||
.. literalinclude:: samples/networks/version-show-response.json
|
- rel: version-rel
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
List API versions
|
|
||||||
=================
|
|
||||||
|
|
||||||
.. rest_method:: GET /
|
|
||||||
|
|
||||||
Lists information about all Networking API versions.
|
|
||||||
|
|
||||||
Normal response codes: 200
|
|
||||||
|
|
||||||
Error response codes: 300
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. .. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/networks/versions-list-response.json
|
.. literalinclude:: samples/networks/versions-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
Show API v2 details
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. rest_method:: GET /v2.0/
|
||||||
|
|
||||||
|
Shows details for Networking API v2.0.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Error response codes: 401
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. .. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
Response Parameters
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- resources: resources
|
||||||
|
- name: resource-name
|
||||||
|
- collection: resource-collection
|
||||||
|
- links: resource-links
|
||||||
|
- href: resource-href
|
||||||
|
- rel: resource-rel
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/networks/version-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
Loading…
Reference in New Issue
Block a user