sudoxreboot/habitica
1
0
Fork 0
mirror of https://github.com/sudoxnym/habitica.git synced 2026-08-05 12:02:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(swagger): correct API docs, fix #3679

Browse source
This commit is contained in:
Matteo Pagliazzi 2014-07-03 18:44:56 +02:00
parent 967c46be87
commit e72a6668fc
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/routes/apiv2.coffee
View file

@ -162,7 +162,7 @@ module.exports = (swagger, v2) ->
description: "Sell inventory items back to Alexander"
parameters: [
#TODO verify these are the correct types
path('type',"The type of object you're selling back.",'string',['eggs','hatchingPotions','food'])
path('type',"The type of object you're selling back.",'string',['gear','eggs','hatchingPotions','food'])
path('key',"The object key you're selling back (call /content route for available keys)",'string')
]
action: user.sell
@ -172,7 +172,7 @@ module.exports = (swagger, v2) ->
method: 'POST'
description: "Purchase a gem-purchaseable item from Alexander"
parameters:[
path('type',"The type of object you're purchasing.",'string',['eggs','hatchingPotions','food','quests','special'])
path('type',"The type of object you're purchasing.",'string',['gear','eggs','hatchingPotions','food'])
path('key',"The object key you're purchasing (call /content route for available keys)",'string')
]
action: user.purchase
@ -191,7 +191,7 @@ module.exports = (swagger, v2) ->
"/user/inventory/equip/{type}/{key}":
spec:
method: 'POST'
description: "Equip an item (either pet, mount, equipped or costume)"
description: "Equip an item (either pets, mounts, or gear)"
parameters: [
path 'type',"Type to equip",'string',['pet','mount','equipped', 'costume']
path 'key',"The object key you're equipping (call /content route for available keys)",'string'
@ -372,7 +372,7 @@ module.exports = (swagger, v2) ->
"/groups/{gid}:GET":
spec:
path: '/groups/{gid}'
description: "Get a group. The party the user currently is in can be accessed with the gid 'party'."
description: "Get a group"
parameters: [path('gid','Group ID','string')]
middleware: [auth.auth, i18n.getUserLanguage]
action: groups.get
@ -489,8 +489,11 @@ module.exports = (swagger, v2) ->
"/groups/{gid}/chat/{messageId}":
spec:
method: 'DELETE'
description: 'Delete a group'
parameters: [path('gid','ID of group to delete','string')]
description: 'Delete a chat message in a given group'
parameters: [
path 'gid', 'ID of the group containing the message to be deleted', 'string'
path 'messageId', 'ID of message to be deleted', 'string'
]
middleware: [auth.auth, i18n.getUserLanguage, groups.attachGroup]
action: groups.deleteChatMessage