DeforaNetworks/corteza
3
0
Fork 0
Code Activity

regenerate docs

Browse Source
This commit is contained in:
Tit Petric
2018-06-03 16:01:24 +02:00
parent deef96ff30
commit 7d7c6befe7
8 changed files with 406 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+356 -1
View File
@@ -4,6 +4,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Update organisation details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -13,6 +19,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Remove organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -21,6 +33,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Read organisation details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -29,6 +47,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Search organisations
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -37,6 +61,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Archive organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/archive` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -45,6 +75,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Update organisation details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -54,6 +90,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Remove organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -62,6 +104,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Read organisation details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -70,6 +118,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Search organisations
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -78,6 +132,12 @@ Organisations represent a top-level grouping entity. There may be many organisat
## Archive organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/organisation/archive` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -93,6 +153,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Update team details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -103,6 +169,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Remove team
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -111,6 +183,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Read team details and memberships
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -119,6 +197,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Search teams
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -127,6 +211,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Archive team
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/archive` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -135,6 +225,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Move team to different organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/move` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -144,6 +240,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Update team details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -154,6 +256,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Remove team
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -162,6 +270,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Read team details and memberships
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -170,6 +284,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Search teams
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -178,6 +298,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Archive team
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/archive` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -186,6 +312,12 @@ An organisation may have many teams. Teams may have many channels available. Acc
## Move team to different organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/team/move` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -202,6 +334,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Update channel details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -212,6 +350,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Remove channel
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -220,6 +364,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Read channel details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -228,6 +378,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Search channels
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -236,6 +392,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Archive channel
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/archive` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -244,6 +406,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Move channel to different team or organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/move` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -252,6 +420,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Merge one team into another
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/merge` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -261,6 +435,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Update channel details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -271,6 +451,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Remove channel
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -279,6 +465,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Read channel details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -287,6 +479,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Search channels
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -295,6 +493,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Archive channel
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/archive` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -303,6 +507,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Move channel to different team or organisation
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/move` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -311,6 +521,12 @@ A channel is a representation of a sequence of messages. It has meta data like c
## Merge one team into another
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/channel/merge` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -345,6 +561,12 @@ The following event types may be sent with a message event:
## New message / edit message
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -355,6 +577,12 @@ The following event types may be sent with a message event:
## Attach file to message
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/attach` | HTTP/S | PUT | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -362,6 +590,12 @@ The following event types may be sent with a message event:
## Remove message
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -370,6 +604,12 @@ The following event types may be sent with a message event:
## Read message details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -378,6 +618,12 @@ The following event types may be sent with a message event:
## Search messages
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -387,6 +633,12 @@ The following event types may be sent with a message event:
## Pin message to channel (public bookmark)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/pin` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -395,6 +647,12 @@ The following event types may be sent with a message event:
## Flag message for user (bookmark)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/flag` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -403,6 +661,12 @@ The following event types may be sent with a message event:
## New message / edit message
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/edit` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -413,6 +677,12 @@ The following event types may be sent with a message event:
## Attach file to message
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/attach` | HTTP/S | PUT | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -420,6 +690,12 @@ The following event types may be sent with a message event:
## Remove message
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/remove` | HTTP/S | DELETE | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -428,6 +704,12 @@ The following event types may be sent with a message event:
## Read message details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/read` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -436,6 +718,12 @@ The following event types may be sent with a message event:
## Search messages
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -445,6 +733,12 @@ The following event types may be sent with a message event:
## Pin message to channel (public bookmark)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/pin` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -453,6 +747,12 @@ The following event types may be sent with a message event:
## Flag message for user (bookmark)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/message/flag` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -466,6 +766,12 @@ The following event types may be sent with a message event:
## Member login
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/login` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -475,6 +781,12 @@ The following event types may be sent with a message event:
## Search members (Directory)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -483,6 +795,12 @@ The following event types may be sent with a message event:
## Member login
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/login` | HTTP/S | POST | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
@@ -492,8 +810,45 @@ The following event types may be sent with a message event:
## Search members (Directory)
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/member/search` | HTTP/S | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| query | string | GET | Search query to match against users | N/A | NO |
| query | string | GET | Search query to match against users | N/A | NO |
# Websocket
## Bidirectional websocket chat connection
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/websocket/client` | WebSockets | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
## Bidirectional websocket chat connection
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/websocket/client` | WebSockets | GET | Client ID, Session ID |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
docs/README.tpl
+6
View File
@@ -8,6 +8,12 @@
{call.description}
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `{api.path}{call.path}` | {if $api.protocol}{api.protocol}{else}HTTP/S{/if} | {call.method} | {eval echo implode(", ", $api.authentication)} |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
docs/src/spec.json
+19
View File
@@ -4,6 +4,7 @@
"description": "Organisations represent a top-level grouping entity. There may be many organisations defined in a single deployment.",
"package": "crust",
"entrypoint": "organisation",
"authentication": ["Client ID", "Session ID"],
"apis": [
{
"name": "edit",
@@ -63,6 +64,7 @@
"description": "An organisation may have many teams. Teams may have many channels available. Access to channels may be shared between teams.",
"package": "crust",
"entrypoint": "team",
"authentication": ["Client ID", "Session ID"],
"apis": [
{
"name": "edit",
@@ -134,6 +136,7 @@
"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",
"entrypoint": "channel",
"authentication": ["Client ID", "Session ID"],
"apis": [
{
"name": "edit",
@@ -214,6 +217,7 @@
"title": "Messages",
"package": "crust",
"entrypoint": "message",
"authentication": ["Client ID", "Session ID"],
"apis": [
{
"name": "edit",
@@ -301,6 +305,7 @@
"title": "Members",
"package": "crust",
"entrypoint": "member",
"authentication": ["Client ID", "Session ID"],
"apis": [
{
"name": "login",
@@ -324,5 +329,19 @@
}
}
]
},
{
"title": "Websocket",
"package": "crust",
"entrypoint": "websocket",
"protocol": "WebSockets",
"authentication": ["Client ID", "Session ID"],
"apis": [
{
"name": "client",
"method": "GET",
"title": "Bidirectional websocket chat connection"
}
]
}
]
docs/src/spec/channel.json
+5
View File
@@ -3,6 +3,11 @@
"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",
"Interface": "Channel",
"Protocol": "",
"Authentication": [
"Client ID",
"Session ID"
],
"Path": "/channel",
"APIs": [
{
docs/src/spec/member.json
+5
View File
@@ -2,6 +2,11 @@
"Title": "Members",
"Package": "crust",
"Interface": "Member",
"Protocol": "",
"Authentication": [
"Client ID",
"Session ID"
],
"Path": "/member",
"APIs": [
{
docs/src/spec/message.json
+5
View File
@@ -2,6 +2,11 @@
"Title": "Messages",
"Package": "crust",
"Interface": "Message",
"Protocol": "",
"Authentication": [
"Client ID",
"Session ID"
],
"Path": "/message",
"APIs": [
{
docs/src/spec/organisation.json
+5
View File
@@ -3,6 +3,11 @@
"Description": "Organisations represent a top-level grouping entity. There may be many organisations defined in a single deployment.",
"Package": "crust",
"Interface": "Organisation",
"Protocol": "",
"Authentication": [
"Client ID",
"Session ID"
],
"Path": "/organisation",
"APIs": [
{
docs/src/spec/team.json
+5
View File
@@ -3,6 +3,11 @@
"Description": "An organisation may have many teams. Teams may have many channels available. Access to channels may be shared between teams.",
"Package": "crust",
"Interface": "Team",
"Protocol": "",
"Authentication": [
"Client ID",
"Session ID"
],
"Path": "/team",
"APIs": [
{