From 6a73e976b0eea0a2138b329284cc1022e96cfe84 Mon Sep 17 00:00:00 2001
From: Ha Van Tu <tuhv@vn.fujitsu.com>
Date: Fri, 19 Aug 2016 13:29:21 +0700
Subject: [PATCH] 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
---
 api-ref/source/v2/parameters.yaml | 72 +++++++++++++++++++++++++++++
 api-ref/source/v2/versions.inc    | 76 ++++++++++++++++++-------------
 2 files changed, 116 insertions(+), 32 deletions(-)

diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml
index eff2422e5..1fc2e2a4f 100644
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@@ -3046,6 +3046,42 @@ remote_ip_prefix_2:
   in: body
   required: true
   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:
   description: |
     The route mode. A valid value is ``static``,
@@ -4223,6 +4259,42 @@ value_1:
   in: body
   required: true
   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:
   description: |
     A ``vip`` object.
diff --git a/api-ref/source/v2/versions.inc b/api-ref/source/v2/versions.inc
index 771b167cb..b2c2caa42 100644
--- a/api-ref/source/v2/versions.inc
+++ b/api-ref/source/v2/versions.inc
@@ -1,8 +1,5 @@
 .. -*- rst -*-
-.. needs:method_verification
-.. needs:parameter_verification
 .. needs:example_verification
-.. needs:body_verification
 
 ============
 API versions
@@ -10,17 +7,15 @@ 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
 
-Error response codes: 203
-
 Request
 -------
 
@@ -31,32 +26,49 @@ Response Parameters
 
 .. rest_parameters:: parameters.yaml
 
-   - location: location
-
-Response Example
-----------------
-
-.. literalinclude:: samples/networks/version-show-response.json
-   :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
+   - versions: versions
+   - status: version-status
+   - id: version-id
+   - links: version-links
+   - href: version-href
+   - rel: version-rel
 
 Response Example
 ----------------
 
 .. literalinclude:: samples/networks/versions-list-response.json
    :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