glenux-contrib/metamaps--metamaps
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

PUT and PATCH parameters are optional

Browse source
This commit is contained in:
Devin Howard 2016-10-04 15:30:06 +08:00
parent 2466a0912f
commit 8ac8aad105
5 changed files with 81 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/api/apis/mappings.raml
View file

@ -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:

12
doc/api/apis/maps.raml
View file

@ -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:

28
doc/api/apis/synapses.raml
View file

@ -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: |
<code>from-to</code> or <code>both</code>
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: |
<code>from-to</code> or <code>both</code>
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: |
<code>from-to</code> or <code>both</code>
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:

1
doc/api/apis/tokens.raml
View file

@ -5,6 +5,7 @@ post:
properties:
description:
description: short string describing this token
required: false
responses:
201:
body:

32
doc/api/apis/topics.raml
View file

@ -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: