Introduce describedby link relation

dgeb · dgeb · commit 2e61b5273375 · 2019-12-03T14:07:32.000-05:00
diff --git a/_format/1.1/index.md b/_format/1.1/index.md
@@ -114,6 +114,8 @@ The top-level [links object][links] **MAY** contain the following members:
   resource relationship.
 * `profile`: an array of [links][link], each specifying a [profile][profiles]
   in use in the document.
+* `describedby`: a [link] to a description document (e.g. OpenAPI or JSON
+  Schema) for the current document.
 * [pagination] links for the primary data.
 
 The document's "primary data" is a representation of the resource or collection
@@ -538,6 +540,8 @@ Within this object, a link **MUST** be represented as either:
     [relationship object][relationships] in which the link appears.
   * `params`: a [link parameter object][link parameters] describing additional
     information about the link or its target.
+  * `describedby`: a [link] to a description document (e.g. OpenAPI or JSON
+    Schema) for the link target.
   * `meta`: a meta object containing non-standard meta-information about the
     link.
 
