Merge "Remove the redundant index page for APIs entry"

api-ref/source/arqs.inc

@@ -24,7 +24,7 @@ for all accelerator_requests.
 
 **Example response: list all accelerator requests**
 
-.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-list-resp.json
+.. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-list-resp.json
    :language: javascript
 
 Get One Accelerator Request
@@ -43,7 +43,7 @@ Request
 
 **Example response: get details of a specific accelerator request**
 
-.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-getone-resp.json
+.. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-getone-resp.json
 
 Create Accelerator Requests
 ---------------------------
@@ -60,11 +60,11 @@ Request
 
 **Example post curl**
 
-.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-post-curl.json
+.. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-post-curl.json
 
 **Example response: create an accelerator request**
 
-.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-create-resp.json
+.. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-create-resp.json
 
 Update Accelerator Requests
 ---------------------------
@@ -90,11 +90,11 @@ Request
 
 **Example patch curl**
 
-.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-patch-curl.json
+.. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-patch-curl.json
 
 **Example response: update an accelerator request**
 
-.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-after-update-resp.json
+.. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-after-update-resp.json
 
 Delete Accelerator Requests by ARQ uuid
 ---------------------------------------

api-ref/source/deployables.inc

@@ -22,7 +22,7 @@ Error response codes: unauthorized(401), forbidden(403)
 
 **Example response: list all deployables**
 
-.. literalinclude:: ../../../doc/api_samples/deployables/deployables-list-resp.json
+.. literalinclude:: ../../doc/api_samples/deployables/deployables-list-resp.json
    :language: javascript
 
 Get One Deployable
@@ -44,5 +44,5 @@ Request
 
 **Example response: show details of a specific deployable**
 
-.. literalinclude:: ../../../doc/api_samples/deployables/deployables-getone-resp.json
+.. literalinclude:: ../../doc/api_samples/deployables/deployables-getone-resp.json
    :language: javascript

api-ref/source/device_profile.inc

@@ -43,7 +43,7 @@ Response
 
 **Example response: list all device profiles**
 
-.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-list-resp.json
+.. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-list-resp.json
    :language: javascript
 
 Get One Device Profile
@@ -78,7 +78,7 @@ Response
 
 **Example response: get details of a specific device profile**
 
-.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-getone-resp.json
+.. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-getone-resp.json
    :language: javascript
 
 Create Device Profile
@@ -114,17 +114,17 @@ Response
 
 **Example post curl with resource/trait**
 
-.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-post-curl.json
+.. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-post-curl.json
    :language: javascript
 
 **Example post curl with a cyborg property when bitstream is required**
 
-.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-post-curl-with-bitstream.json
+.. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-post-curl-with-bitstream.json
    :language: javascript
 
 **Example response: create a device profile**
 
-.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-create-resp.json
+.. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-create-resp.json
    :language: javascript
 
 Delete One Device Profile by uuid

api-ref/source/devices.inc

@@ -21,7 +21,7 @@ Error response codes: unauthorized(401), forbidden(403)
 
 **Example response: list all devices**
 
-.. literalinclude:: ../../../doc/api_samples/devices/devices-list-resp.json
+.. literalinclude:: ../../doc/api_samples/devices/devices-list-resp.json
    :language: javascript
 
 Get One Device
@@ -43,5 +43,5 @@ Request
 
 **Example response: show details of a specific device**
 
-.. literalinclude:: ../../../doc/api_samples/devices/devices-getone-resp.json
+.. literalinclude:: ../../doc/api_samples/devices/devices-getone-resp.json
    :language: javascript

api-ref/source/index.rst

@@ -2,10 +2,17 @@
 OpenStack Acceleration APIs
 ===========================
 
-This is a reference for the OpenStack Acceleration API which is provided by
-the Cyborg project.
+This is a reference for the OpenStack Acceleration v2 API which is provided
+by the Cyborg project. Starting from Ussuri, Cyborg supports only Version 2
+REST APIs. The Version 1 APIs were deprecated in Train and shall be removed
+in Ussuri.
 
-.. toctree::
-   :maxdepth: 1
+.. rest_expand_all::
 
-   v2/index
+.. include:: device_profile.inc
+
+.. include:: arqs.inc
+
+.. include:: devices.inc
+
+.. include:: deployables.inc

api-ref/source/v2/index.rst

@@ -1,18 +0,0 @@
-==============================
-OpenStack Acceleration v2 APIs
-==============================
-
-This is a reference for the OpenStack Acceleration v2 API which is provided
-by the Cyborg project. Starting from Ussuri, Cyborg supports only Version 2
-REST APIs. The Version 1 APIs were deprecated in Train and shall be removed
-in Ussuri.
-
-.. rest_expand_all::
-
-.. include:: device_profile.inc
-
-.. include:: arqs.inc
-
-.. include:: devices.inc
-
-.. include:: deployables.inc