Changes

Page history
Change url from github wiki to gitlab wiki authored by Bernhard Millauer's avatar Bernhard Millauer
Hide whitespace changes
Inline Side-by-side
Home.md
View page @ ae8f7abd
...@@ -10,13 +10,13 @@ Don't worry, you'll soon be on your way to creating useful bips! ...@@ -10,13 +10,13 @@ Don't worry, you'll soon be on your way to creating useful bips!
### So how does it work? ### So how does it work?
When you [define a bip](https://github.com/bipio-server/bipio/wiki/Bips), you are defining the characteristics of a [directed graph](https://en.wikipedia.org/wiki/Directed_graph). When you [define a bip](https://gitlab.com/bipio/docs/wikis/Bips), you are defining the characteristics of a [directed graph](https://en.wikipedia.org/wiki/Directed_graph).
When a message is received from a web hook, incoming email or generated from a trigger, it appears on a bips graph from the 'source' node. The source data is then normalized into a JSON structure and 'exported' via RabbitMQ for consumption as 'imports' by adjacent nodes. This pipeline continues until all nodes have been visited. When a message is received from a web hook, incoming email or generated from a trigger, it appears on a bips graph from the 'source' node. The source data is then normalized into a JSON structure and 'exported' via RabbitMQ for consumption as 'imports' by adjacent nodes. This pipeline continues until all nodes have been visited.
A node in a bip usually represents a [Remote Procedure Call](https://en.wikipedia.org/wiki/Remote_procedure_call) (RPC) on an external service, which is a discrete 'action' provided by a ['pod'](https://github.com/bipio-server/bipio/wiki/Pods). A node in a bip usually represents a [Remote Procedure Call](https://en.wikipedia.org/wiki/Remote_procedure_call) (RPC) on an external service, which is a discrete 'action' provided by a ['pod'](https://gitlab.com/bipio/docs/wikis/Pods).
Prior to consumption by an action, imports can be modified in different ways. These modifications are called 'transforms', or ['personalizations'](https://bip.uservoice.com/knowledgebase/articles/502740-personalizing-your-integrations) in the UI. As a message is pushed through a graph, an object is built containing exports from visited nodes which can be plucked out with [JSONPath](http://goessner.net/articles/JsonPath). Using these JSONPath expressions and a simple [templating system](https://github.com/bipio-server/bipio/wiki/Transforms-And-Templates), imports can be composed as you like. Prior to consumption by an action, imports can be modified in different ways. These modifications are called 'transforms', or ['personalizations'](https://bip.uservoice.com/knowledgebase/articles/502740-personalizing-your-integrations) in the UI. As a message is pushed through a graph, an object is built containing exports from visited nodes which can be plucked out with [JSONPath](http://goessner.net/articles/JsonPath). Using these JSONPath expressions and a simple [templating system](https://gitlab.com/bipio/docs/wikis/Transforms-And-Templates), imports can be composed as you like.
## API ## API
...@@ -59,10 +59,10 @@ You can expose an account UUID by shelling into mongodb and running the appropri ...@@ -59,10 +59,10 @@ You can expose an account UUID by shelling into mongodb and running the appropri
[REST Resources](http://en.wikipedia.org/wiki/Representational_state_transfer) honor GET/POST/PUT/DELETE/PATCH. [REST Resources](http://en.wikipedia.org/wiki/Representational_state_transfer) honor GET/POST/PUT/DELETE/PATCH.
* [`/rest/account_option/:id?`](https://github.com/bipio-server/bipio/wiki/Account-Options) POST/DELETE is not supported for `account_option`. * [`/rest/account_option/:id?`](https://gitlab.com/bipio/docs/wikis/Account-Options) POST/DELETE is not supported for `account_option`.
* [`/rest/bip/:id?`](https://github.com/bipio-server/bipio/wiki/Bips) * [`/rest/bip/:id?`](https://gitlab.com/bipio/docs/wikis/Bips)
* [`/rest/channel/:id?`](https://github.com/bipio-server/bipio/wiki/Channels) * [`/rest/channel/:id?`](https://gitlab.com/bipio/docs/wikis/Channels)
* [`/rest/domain/:id?`](https://github.com/bipio-server/bipio/wiki/Domains) * [`/rest/domain/:id?`](https://gitlab.com/bipio/docs/wikis/Domains)
#### Decorators #### Decorators
...@@ -107,18 +107,18 @@ GET /rest/domain?page=1&page_size=10&order_by=recent ...@@ -107,18 +107,18 @@ GET /rest/domain?page=1&page_size=10&order_by=recent
[RPC's](http://en.wikipedia.org/wiki/Remote_procedure_call) provide certain behaviors and helpers for performing work, negotiating authentication or generating content. [RPC's](http://en.wikipedia.org/wiki/Remote_procedure_call) provide certain behaviors and helpers for performing work, negotiating authentication or generating content.
* Describe a Model [`/rpc/describe/:model/:submodel`](https://github.com/bipio-server/bipio/wiki/Describing-Models) * Describe a Model [`/rpc/describe/:model/:submodel`](https://gitlab.com/bipio/docs/wikis/Describing-Models)
* Call a Channel Renderer [`/rpc/render/channel/:channel_id/:renderer`](https://github.com/bipio-server/bipio/wiki/Channels#channel-renderers) * Call a Channel Renderer [`/rpc/render/channel/:channel_id/:renderer`](https://gitlab.com/bipio/docs/wikis/Channels#channel-renderers)
* Negotiate OAuth [`/rpc/oauth/:pod_name/:auth_method`](https://github.com/bipio-server/bipio/wiki/Pods#oauth) * Negotiate OAuth [`/rpc/oauth/:pod_name/:auth_method`](https://gitlab.com/bipio/docs/wikis/Pods#oauth)
* Set Credential Tokens [`/rpc/issuer_token/:pod_name/:auth_method`](https://github.com/bipio-server/bipio/wiki/Pods#issuer-tokens) * Set Credential Tokens [`/rpc/issuer_token/:pod_name/:auth_method`](https://gitlab.com/bipio/docs/wikis/Pods#issuer-tokens)
* Get Referer [`/rpc/get_referer_hint`](https://github.com/bipio-server/bipio/wiki/RPC-Get-Referer-Hint) * Get Referer [`/rpc/get_referer_hint`](https://gitlab.com/bipio/docs/wikis/RPC-Get-Referer-Hint)
* Create Bip from Referer [`/rpc/bip/create_from_referer`](https://github.com/bipio-server/bipio/wiki/RPC-Create-From-Referer) * Create Bip from Referer [`/rpc/bip/create_from_referer`](https://gitlab.com/bipio/docs/wikis/RPC-Create-From-Referer)
* Get Transform Hint [`/rpc/bip/get_transform_hint`](https://github.com/bipio-server/bipio/wiki/RPC-Get-Transform-Hint) * Get Transform Hint [`/rpc/bip/get_transform_hint`](https://gitlab.com/bipio/docs/wikis/RPC-Get-Transform-Hint)
* Share a Bip [`/rpc/bip/share`](https://github.com/bipio-server/bipio/wiki/RPC-Share-Bip) * Share a Bip [`/rpc/bip/share`](https://gitlab.com/bipio/docs/wikis/RPC-Share-Bip)
* List Shares [`/rpc/bip/share/list`](https://github.com/bipio-server/bipio/wiki/RPC-List-Shared-Bips) * List Shares [`/rpc/bip/share/list`](https://gitlab.com/bipio/docs/wikis/RPC-List-Shared-Bips)
* Unshare [`/rpc/bip/unshare`](https://github.com/bipio-server/bipio/wiki/RPC-Un-Share-Bip) * Unshare [`/rpc/bip/unshare`](https://gitlab.com/bipio/docs/wikis/RPC-Un-Share-Bip)
* Set Account Attribute [`/rpc/bip/set_default`](https://github.com/bipio-server/bipio/wiki/Account-options#rpc--set-default) * Set Account Attribute [`/rpc/bip/set_default`](https://gitlab.com/bipio/docs/wikis/Account-options#rpc--set-default)
* Confirm Domain Delegation [`/rpc/domain/confirm`](https://github.com/bipio-server/bipio/wiki/Domains#rpc--domain-confirm) * Confirm Domain Delegation [`/rpc/domain/confirm`](https://gitlab.com/bipio/docs/wikis/Domains#rpc--domain-confirm)
... ...
......