Changes

Page history
removed trailing space authored by Yiu Fat Tse's avatar Yiu Fat Tse
Hide whitespace changes
Inline Side-by-side
Home.md
View page @ 6862800a
......@@ -17,7 +17,7 @@ Don't worry, you'll soon be on your way to creating useful graphs!
* [Rate Limiting](https://github.com/bipio-server/bipio/wiki#rate-limiting)
## Useful why?
## Useful why?
There are many reasons to use an ephemeral graph system, here's some highlights
......@@ -58,7 +58,7 @@ For https://bip.io hosted users, bipio has 2 endpoints that you'll likely be usi
### Authentication
The API uses [HTTP Basic Authentication](http://en.wikipedia.org/wiki/Basic_access_authentication). Username will be your account username, and password is a generated API token.
The API uses [HTTP Basic Authentication](http://en.wikipedia.org/wiki/Basic_access_authentication). Username will be your account username, and password is a generated API token.
`curl http://admin:4a4b27ec88763a3c371916d2e23a2000@bipio.local:5000/rest/bip/637658bb-eb15-4d59-9e0e-abb39021e40e`
......@@ -74,7 +74,7 @@ You can expose an account UUID by shelling into mongodb and running the appropri
### REST
[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/bip/:id?`](https://github.com/bipio-server/bipio/wiki/Bips)
......@@ -85,7 +85,7 @@ You can expose an account UUID by shelling into mongodb and running the appropri
Most REST resources also have additional response decorators attached to each model which provides a little extra info. Decorators are prefixed with an underscore and are read-only. eg: `_href : "https://docs.bip.io/rest/bip/bc928113-0a98-4975-a821-98373aa72552"`
The two most common are
The two most common are
* **_href** (URI) Fully Qualified Resource URI
* **_repr** (String) Derived representation.
......@@ -120,7 +120,7 @@ GET /rest/domain?page=1&page_size=10&order_by=recent
}
```
### RPC
### RPC
[RPC's](http://en.wikipedia.org/wiki/Remote_procedure_call) provide certain behaviors and helpers for performing work, negotiating authentication or generating content.
......@@ -163,7 +163,7 @@ The first time you setup bipio via `make install`, it will ask you some question
* **public_interfaces** (array, optional) list of resolvable IP's (V4|V6) for internal domain resolution. omit to autodiscover.
* **ssl** (object, optional) key and certificate paths for SSL
* **key** (string) key path
* **cert** (string) certificate path
* **cert** (string) certificate path
* **mailer** (object) Outbound Mailer Config
* **port** (string) Relay Port
* **host** (string) Relay host or IP
......
......