From 9f6b96e3336c98f5f0004206d73a5b0b122b9183 Mon Sep 17 00:00:00 2001
From: Sean Dague <sean@dague.net>
Date: Sat, 23 Apr 2016 18:59:22 -0400
Subject: [PATCH] Add links to API guide to describe links

We have a pretty generic parameter for links, which lets us reuse it,
which is good. This updates the description to link to the API guide
to explain the concepts on links.

Part of bp:api-ref-in-rst

Change-Id: Ic05428cf20ee8652c09b993046d491453c328a4c
---
 api-ref/source/parameters.yaml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 310a46fbad..b48482a80d 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -1289,7 +1289,10 @@ limit_1:
   type: integer
 links:
   description: |
-    Permalinks to resources.
+    Links to the resources in question. See `API Guide / Links and
+    References
+    <http://docs.openstack.org/developer/nova/v2/links_and_references.html>`_
+    for more info.
   in: body
   required: true
   type: array