DeforaNetworks/corteza
DeforaNetworks/corteza
3
0
Fork 0
Code

import docs

Browse Source
This commit is contained in:
Tit Petric 2018-06-03 12:19:54 +02:00
parent 064c273527
commit 73dae56496
7 changed files with 270 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/_spec.json
View File

@ -1,6 +1,7 @@
[
{
"title": "Organisations",
"package": "crust",
"entrypoint": "organisation",
"apis": {
"add": {
@ -31,6 +32,7 @@
},
{
"title": "Teams",
"package": "crust",
"entrypoint": "team",
"apis": {
"add": {
@ -65,6 +67,7 @@
},
{
"title": "Channels",
"package": "crust",
"entrypoint": "channel",
"apis": {
"add": {
@ -99,6 +102,7 @@
},
{
"title": "Messages",
"package": "crust",
"entrypoint": "message",
"apis": {
"add": {
@ -133,6 +137,7 @@
},
{
"title": "Members",
"package": "crust",
"entrypoint": "member",
"apis": {
"add": {
@ -159,6 +164,7 @@
},
{
"title": "Files",
"package": "crust",
"entrypoint": "file",
"apis": {
"add": {

50
docs/src/channel.json Normal file
View File

@ -0,0 +1,50 @@
{
"Title": "Channels",
"Package": "crust",
"Interface": "Channel",
"Path": "/channel",
"APIs": {
"add": {
"Method": "POST",
"Title": "Add new channel",
"Path": "/add",
"Parameters": {}
},
"archive": {
"Method": "POST",
"Title": "Archive channel",
"Path": "/archive",
"Parameters": {}
},
"edit": {
"Method": "POST",
"Title": "Update channel details",
"Path": "/edit",
"Parameters": {}
},
"move": {
"Method": "POST",
"Title": "Move channel to different team or organisation",
"Path": "/move",
"Parameters": {}
},
"read": {
"Method": "GET",
"Title": "Read channel details",
"Path": "/read",
"Parameters": {}
},
"remove": {
"Method": "DELETE",
"Title": "Remove channel",
"Path": "/remove",
"Parameters": {}
},
"search": {
"Method": "GET",
"Title": "Search channels",
"Path": "/search",
"Parameters": {}
}
}
}

32
docs/src/file.json Normal file
View File

@ -0,0 +1,32 @@
{
"Title": "Files",
"Package": "crust",
"Interface": "File",
"Path": "/file",
"APIs": {
"add": {
"Method": "POST",
"Title": "Add new file",
"Path": "/add",
"Parameters": {}
},
"read": {
"Method": "GET",
"Title": "Read file",
"Path": "/read",
"Parameters": {}
},
"remove": {
"Method": "DELETE",
"Title": "Remove file",
"Path": "/remove",
"Parameters": {}
},
"search": {
"Method": "GET",
"Title": "Search files",
"Path": "/search",
"Parameters": {}
}
}
}

38
docs/src/member.json Normal file
View File

@ -0,0 +1,38 @@
{
"Title": "Members",
"Package": "crust",
"Interface": "Member",
"Path": "/member",
"APIs": {
"add": {
"Method": "POST",
"Title": "Add new member",
"Path": "/add",
"Parameters": {}
},
"edit": {
"Method": "POST",
"Title": "Update member details",
"Path": "/edit",
"Parameters": {}
},
"read": {
"Method": "GET",
"Title": "Read member details",
"Path": "/read",
"Parameters": {}
},
"remove": {
"Method": "DELETE",
"Title": "Remove member",
"Path": "/remove",
"Parameters": {}
},
"search": {
"Method": "GET",
"Title": "Search members (Directory)",
"Path": "/search",
"Parameters": {}
}
}
}

50
docs/src/message.json Normal file
View File

@ -0,0 +1,50 @@
{
"Title": "Messages",
"Package": "crust",
"Interface": "Message",
"Path": "/message",
"APIs": {
"add": {
"Method": "POST",
"Title": "Add new message",
"Path": "/add",
"Parameters": {}
},
"edit": {
"Method": "POST",
"Title": "Update message details",
"Path": "/edit",
"Parameters": {}
},
"flag": {
"Method": "POST",
"Title": "Flag message for user (bookmark)",
"Path": "/flag",
"Parameters": {}
},
"pin": {
"Method": "POST",
"Title": "Pin message to channel (public bookmark)",
"Path": "/pin",
"Parameters": {}
},
"read": {
"Method": "GET",
"Title": "Read message details",
"Path": "/read",
"Parameters": {}
},
"remove": {
"Method": "DELETE",
"Title": "Remove message",
"Path": "/remove",
"Parameters": {}
},
"search": {
"Method": "GET",
"Title": "Search messages",
"Path": "/search",
"Parameters": {}
}
}
}

44
docs/src/organisation.json Normal file
View File

@ -0,0 +1,44 @@
{
"Title": "Organisations",
"Package": "crust",
"Interface": "Organisation",
"Path": "/organisation",
"APIs": {
"add": {
"Method": "POST",
"Title": "Add new organisation",
"Path": "/add",
"Parameters": {}
},
"archive": {
"Method": "POST",
"Title": "Archive organisation",
"Path": "/archive",
"Parameters": {}
},
"edit": {
"Method": "POST",
"Title": "Update organisation details",
"Path": "/edit",
"Parameters": {}
},
"read": {
"Method": "GET",
"Title": "Read organisation details",
"Path": "/read",
"Parameters": {}
},
"remove": {
"Method": "DELETE",
"Title": "Remove organisation",
"Path": "/remove",
"Parameters": {}
},
"search": {
"Method": "GET",
"Title": "Search organisations",
"Path": "/search",
"Parameters": {}
}
}
}

50
docs/src/team.json Normal file
View File

@ -0,0 +1,50 @@
{
"Title": "Teams",
"Package": "crust",
"Interface": "Team",
"Path": "/team",
"APIs": {
"add": {
"Method": "POST",
"Title": "Add new team",
"Path": "/add",
"Parameters": {}
},
"archive": {
"Method": "POST",
"Title": "Archive team",
"Path": "/archive",
"Parameters": {}
},
"edit": {
"Method": "POST",
"Title": "Update team details",
"Path": "/edit",
"Parameters": {}
},
"move": {
"Method": "POST",
"Title": "Move team to different organisation",
"Path": "/move",
"Parameters": {}
},
"read": {
"Method": "GET",
"Title": "Read team details",
"Path": "/read",
"Parameters": {}
},
"remove": {
"Method": "DELETE",
"Title": "Remove team",
"Path": "/remove",
"Parameters": {}
},
"search": {
"Method": "GET",
"Title": "Search teams",
"Path": "/search",
"Parameters": {}
}
}
}