DeforaNetworks/corteza
3
0
Fork 0
Code Activity

update specs with structs info

Browse Source
This commit is contained in:
Tit Petric
2018-06-03 18:21:43 +02:00
parent 76e0bbc953
commit 3d4d1775e9
9 changed files with 73 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+9 -9
View File
@@ -762,15 +762,15 @@ The following event types may be sent with a message event:
# Members
# Users
## Member login
## User login
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/login` | HTTP/S | POST | Client ID, Session ID |
| `/users/login` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
@@ -779,13 +779,13 @@ The following event types may be sent with a message event:
| username | string | POST | Username or email | N/A | YES |
| password | string | POST | Password for user | N/A | YES |
## Search members (Directory)
## Search users (Directory)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/search` | HTTP/S | GET | Client ID, Session ID |
| `/users/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
@@ -793,13 +793,13 @@ The following event types may be sent with a message event:
| --------- | ---- | ------ | ----------- | ------- | --------- |
| query | string | GET | Search query to match against users | N/A | NO |
## Member login
## User login
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/login` | HTTP/S | POST | Client ID, Session ID |
| `/users/login` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
@@ -808,13 +808,13 @@ The following event types may be sent with a message event:
| username | string | POST | Username or email | N/A | YES |
| password | string | POST | Password for user | N/A | YES |
## Search members (Directory)
## Search users (Directory)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/search` | HTTP/S | GET | Client ID, Session ID |
| `/users/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
docs/README.php
+1
View File
@@ -57,6 +57,7 @@ foreach ($spec as $api) {
}
$tpl = new Monotek\MiniTPL\Template;
$tpl->set_compile_location("/tmp", true);
$tpl->set_paths("./");
$tpl->load("README.tpl");
$tpl->assign("apis", $apis);
docs/src/spec.json
+57 -10
View File
@@ -2,9 +2,15 @@
{
"title": "Organisations",
"description": "Organisations represent a top-level grouping entity. There may be many organisations defined in a single deployment.",
"package": "crust",
"package": "sam",
"entrypoint": "organisation",
"authentication": ["Client ID", "Session ID"],
"structs": {
"Organisation": [
{ "name": "ID", "type": "uint64" },
{ "name": "Name", "type": "string" }
]
},
"apis": [
{
"name": "edit",
@@ -62,9 +68,17 @@
{
"title": "Teams",
"description": "An organisation may have many teams. Teams may have many channels available. Access to channels may be shared between teams.",
"package": "crust",
"package": "sam",
"entrypoint": "team",
"authentication": ["Client ID", "Session ID"],
"structs": {
"Team": [
{ "type": "uint64", "name": "ID" },
{ "type": "string", "name": "Name" },
{ "type": "[]uint64", "name": "MemberIDs", "tag": "json:\"-\"" },
{ "type": "[]User", "name": "Members", "tag": "json:\",omitempty\"" }
]
},
"apis": [
{
"name": "edit",
@@ -134,9 +148,16 @@
{
"title": "Channels",
"description": "A channel is a representation of a sequence of messages. It has meta data like channel subject. Channels may be public, private or direct (between two users).",
"package": "crust",
"package": "sam",
"entrypoint": "channel",
"authentication": ["Client ID", "Session ID"],
"structs": {
"Channels": [
{ "type": "uint64", "name": "ID" },
{ "type": "string", "name": "Name" },
{ "type": "string", "name": "Topic" }
]
},
"apis": [
{
"name": "edit",
@@ -215,9 +236,22 @@
},
{
"title": "Messages",
"package": "crust",
"package": "sam",
"entrypoint": "message",
"authentication": ["Client ID", "Session ID"],
"structs": {
"Message": [
{ "name": "Service", "type": "string" },
{ "name": "Channel", "type": "string" },
{ "name": "UserName", "type": "string" },
{ "name": "UserID", "type": "uint64" },
{ "name": "User", "type": "*User" },
{ "name": "UserAvatar", "type": "string" },
{ "name": "Message", "type": "string" },
{ "name": "MessageID", "type": "string" },
{ "name": "Type", "type": "MessageType" }
]
},
"apis": [
{
"name": "edit",
@@ -302,15 +336,22 @@
]
},
{
"title": "Members",
"package": "crust",
"entrypoint": "member",
"title": "Users",
"package": "sam",
"entrypoint": "users",
"authentication": ["Client ID", "Session ID"],
"structs": {
"User": [
{ "type": "uint64", "name": "ID" },
{ "username": "string", "name": "Username" },
{ "password": "string", "name": "Password", "tag": "json:\"-\"" }
]
},
"apis": [
{
"name": "login",
"method": "POST",
"title": "Member login",
"title": "User login",
"parameters": {
"post": [
{ "type": "string", "name": "username", "required": true, "title": "Username or email" },
@@ -321,7 +362,7 @@
{
"name": "search",
"method": "GET",
"title": "Search members (Directory)",
"title": "Search users (Directory)",
"parameters": {
"get": [
{ "type": "string", "name": "query", "required": false, "title": "Search query to match against users" }
@@ -332,10 +373,16 @@
},
{
"title": "Websocket",
"package": "crust",
"package": "sam",
"entrypoint": "websocket",
"protocol": "WebSockets",
"authentication": ["Client ID", "Session ID"],
"structs": {
"WebSocket": [
{ "type": "uint64", "name": "UserID" },
{ "type": "User", "name": "User" }
]
},
"apis": [
{
"name": "client",
docs/src/spec/channel.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"Title": "Channels",
"Description": "A channel is a representation of a sequence of messages. It has meta data like channel subject. Channels may be public, private or direct (between two users).",
"Package": "crust",
"Package": "sam",
"Interface": "Channel",
"Protocol": "",
"Authentication": [
docs/src/spec/member.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"Title": "Members",
"Package": "crust",
"Package": "sam",
"Interface": "Member",
"Protocol": "",
"Authentication": [
docs/src/spec/message.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"Title": "Messages",
"Package": "crust",
"Package": "sam",
"Interface": "Message",
"Protocol": "",
"Authentication": [
docs/src/spec/organisation.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"Title": "Organisations",
"Description": "Organisations represent a top-level grouping entity. There may be many organisations defined in a single deployment.",
"Package": "crust",
"Package": "sam",
"Interface": "Organisation",
"Protocol": "",
"Authentication": [
docs/src/spec/team.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"Title": "Teams",
"Description": "An organisation may have many teams. Teams may have many channels available. Access to channels may be shared between teams.",
"Package": "crust",
"Package": "sam",
"Interface": "Team",
"Protocol": "",
"Authentication": [
docs/src/spec/websocket.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"Title": "Websocket",
"Package": "crust",
"Package": "sam",
"Interface": "Websocket",
"Protocol": "WebSockets",
"Authentication": [