diff --git a/doc/api/apis/mappings.raml b/doc/api/apis/mappings.raml
index 9d0be18b..a1643c86 100644
--- a/doc/api/apis/mappings.raml
+++ b/doc/api/apis/mappings.raml
@@ -17,9 +17,11 @@ post:
map_id:
description: id of the map
xloc:
- description: (for Topic mappings only) x location on the canvas
+ description: (only for Topic mappings) x location on the canvas
+ required: false
yloc:
- description: (for Topic mappings only) y location on the canvas
+ description: (only for Topic mappings) y location on the canvas
+ required: false
responses:
201:
body:
@@ -40,10 +42,20 @@ post:
properties:
mappable_id:
description: id of the topic/synapse to be mapped
+ required: false
mappable_type:
description: Topic or Synapse
+ required: false
map_id:
description: id of the map
+ required: false
+ xloc:
+ description: (only for Topic mappings) x location on the canvas
+ required: false
+ yloc:
+ description: (only for Topic mappings) y location on the canvas
+ required: false
+
responses:
200:
body:
@@ -55,10 +67,19 @@ post:
properties:
mappable_id:
description: id of the topic/synapse to be mapped
+ required: false
mappable_type:
description: Topic or Synapse
+ required: false
map_id:
description: id of the map
+ required: false
+ xloc:
+ description: (only for Topic mappings) x location on the canvas
+ required: false
+ yloc:
+ description: (only for Topic mappings) y location on the canvas
+ required: false
responses:
200:
body:
diff --git a/doc/api/apis/maps.raml b/doc/api/apis/maps.raml
index 3cc7d13c..b742adce 100644
--- a/doc/api/apis/maps.raml
+++ b/doc/api/apis/maps.raml
@@ -42,16 +42,22 @@ post:
properties:
name:
description: name
+ required: false
desc:
description: description
+ required: false
permission:
description: commons, public, or private
+ required: false
screenshot:
description: url to a screenshot of the map
+ required: false
contributor_ids:
description: the topic being linked from
+ required: false
collaborator_ids:
description: the topic being linked to
+ required: false
responses:
200:
body:
@@ -63,16 +69,22 @@ post:
properties:
name:
description: name
+ required: false
desc:
description: description
+ required: false
permission:
description: commons, public, or private
+ required: false
screenshot:
description: url to a screenshot of the map
+ required: false
contributor_ids:
description: the topic being linked from
+ required: false
collaborator_ids:
description: the topic being linked to
+ required: false
responses:
200:
body:
diff --git a/doc/api/apis/synapses.raml b/doc/api/apis/synapses.raml
index cfd2f762..dabcdad7 100644
--- a/doc/api/apis/synapses.raml
+++ b/doc/api/apis/synapses.raml
@@ -11,9 +11,11 @@ post:
application/json:
properties:
desc:
- description: name
+ description: text description of this synapse
+ required: false
category:
- description: from to or both
+ description: |
+ from-to or both
permission:
description: commons, public, or private
topic1_id:
@@ -41,17 +43,24 @@ post:
application/json:
properties:
desc:
- description: name
+ description: text description of this synapse
+ required: false
category:
- description: from-to or both
+ description: |
+ from-to or both
+ required: false
permission:
description: commons, public, or private
+ required: false
topic1_id:
description: the topic being linked from
+ required: false
topic2_id:
description: the topic being linked to
+ required: false
user_id:
description: the creator of the topic
+ required: false
responses:
200:
body:
@@ -62,17 +71,24 @@ post:
application/json:
properties:
desc:
- description: name
+ description: text description of this synapse
+ required: false
category:
- description: from-to or both
+ description: |
+ from-to or both
+ required: false
permission:
description: commons, public, or private
+ required: false
topic1_id:
description: the topic being linked from
+ required: false
topic2_id:
description: the topic being linked to
+ required: false
user_id:
description: the creator of the topic
+ required: false
responses:
200:
body:
diff --git a/doc/api/apis/tokens.raml b/doc/api/apis/tokens.raml
index 70b69765..ef7a8379 100644
--- a/doc/api/apis/tokens.raml
+++ b/doc/api/apis/tokens.raml
@@ -5,6 +5,7 @@ post:
properties:
description:
description: short string describing this token
+ required: false
responses:
201:
body:
diff --git a/doc/api/apis/topics.raml b/doc/api/apis/topics.raml
index 09706754..15b94da4 100644
--- a/doc/api/apis/topics.raml
+++ b/doc/api/apis/topics.raml
@@ -11,11 +11,11 @@ post:
application/json:
properties:
name:
- description: name
+ description: Topic name; this will be visible on the map
desc:
- description: description
+ description: Longer topic description visible when opening a map card
link:
- description: link to content on the web
+ description: embed a link to content on the web in the topic card
required: false
permission:
description: commons, public, or private
@@ -40,13 +40,20 @@ post:
application/json:
properties:
name:
- description: name
+ description: Topic name; this will be visible on the map
+ required: false
desc:
- description: description
+ description: Longer topic description visible when opening a map card
+ required: false
link:
- description: (optional) link to content on the web
+ description: embed a link to content on the web in the topic card
+ required: false
permission:
description: commons, public, or private
+ required: false
+ metacode_id:
+ description: Topic's metacode
+ required: false
responses:
200:
body:
@@ -57,13 +64,20 @@ post:
application/json:
properties:
name:
- description: name
+ description: Topic name; this will be visible on the map
+ required: false
desc:
- description: description
+ description: Longer topic description visible when opening a map card
+ required: false
link:
- description: (optional) link to content on the web
+ description: embed a link to content on the web in the topic card
+ required: false
permission:
description: commons, public, or private
+ required: false
+ metacode_id:
+ description: Topic's metacode
+ required: false
responses:
200:
body: