metamaps--metamaps/doc/api/apis/maps.raml
2016-10-04 15:30:06 +08:00

96 lines
2.6 KiB
Text

#type: collection
get:
is: [ searchable: { searchFields: "name, desc" }, embeddable: { embedFields: "user,topics,synapses,mappings,contributors,collaborators" }, orderable, pageable ]
responses:
200:
body:
application/json:
example: !include ../examples/maps.json
post:
body:
application/json:
properties:
name:
description: name
desc:
description: description
permission:
description: commons, public, or private
screenshot:
description: url to a screenshot of the map
contributor_ids:
description: the topic being linked from
collaborator_ids:
description: the topic being linked to
responses:
201:
body:
application/json:
example: !include ../examples/map.json
/{id}:
#type: item
get:
is: [ embeddable: { embedFields: "user,topics,synapses,mappings,contributors,collaborators" } ]
responses:
200:
body:
application/json:
example: !include ../examples/map.json
put:
body:
application/json:
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:
application/json:
example: !include ../examples/map.json
patch:
body:
application/json:
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:
application/json:
example: !include ../examples/map.json
delete:
responses:
204:
description: No content