Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting storage #3008

Merged
merged 3 commits into from
Dec 16, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ read-release-cookie:
DIALYZER ?= dialyzer
PLT ?= .kazoo.plt

OTP_APPS ?= erts kernel stdlib crypto public_key ssl asn1 inets
OTP_APPS ?= erts kernel stdlib crypto public_key ssl asn1 inets xmerl
$(PLT): DEPS_SRCS ?= $(shell find $(ROOT)/deps -name src )
# $(PLT): CORE_EBINS ?= $(shell find $(ROOT)/core -name ebin)
$(PLT):
Expand Down
20 changes: 11 additions & 9 deletions applications/crossbar/doc/ref/access_lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#### Schema

Access Control List entries for device or account

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`cidrs` | Classless Inter-Domain Routing IP notation for use on the access lists | `array(string)` | | `true`
Expand All @@ -12,32 +14,32 @@ Key | Description | Type | Default | Required
`user_agent` | RegExp to match valid user agent strings | `string` | | `false`


#### Remove
#### Fetch

> DELETE /v2/accounts/{ACCOUNT_ID}/access_lists
> GET /v2/accounts/{ACCOUNT_ID}/access_lists

```shell
curl -v -X DELETE \
curl -v -X GET \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/access_lists
```

#### Fetch
#### Change

> GET /v2/accounts/{ACCOUNT_ID}/access_lists
> POST /v2/accounts/{ACCOUNT_ID}/access_lists

```shell
curl -v -X GET \
curl -v -X POST \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/access_lists
```

#### Change
#### Remove

> POST /v2/accounts/{ACCOUNT_ID}/access_lists
> DELETE /v2/accounts/{ACCOUNT_ID}/access_lists

```shell
curl -v -X POST \
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/access_lists
```
Expand Down
86 changes: 65 additions & 21 deletions applications/crossbar/doc/ref/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#### Schema

Accounts represent tenants or customers on the system. Each account represents an individual dataset or sandbox that only one tenant can access. The data set is architecturally independent from other tenants.

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`call_restriction` | Account level call restrictions for each available number classification | `object` | `{}` | `false`
Expand Down Expand Up @@ -33,12 +35,16 @@ Key | Description | Type | Default | Required

##### call_waiting

Parameters for server-side call waiting

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`enabled` | Determines if server side call waiting is enabled/disabled | `boolean` | | `false`

##### caller_id

Defines caller ID settings based on the type of call being made

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`emergency` | The caller ID used when a resource is flagged as 'emergency' | `object` | | `false`
Expand All @@ -59,11 +65,15 @@ Key | Description | Type | Default | Required

##### metaflow

A metaflow node defines a module to execute, data to provide to that module, and one or more children to branch to

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------

##### metaflow.audio_level

audio_level metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -75,6 +85,8 @@ Key | Description | Type | Default | Required

##### metaflow.break

break metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -83,6 +95,8 @@ Key | Description | Type | Default | Required

##### metaflow.callflow

callflow metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -92,6 +106,8 @@ Key | Description | Type | Default | Required

##### metaflow.hangup

hangup metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -100,6 +116,8 @@ Key | Description | Type | Default | Required

##### metaflow.hold

hold metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -111,6 +129,8 @@ Key | Description | Type | Default | Required

##### metaflow.hold_control

hold_control metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -120,6 +140,8 @@ Key | Description | Type | Default | Required

##### metaflow.intercept

intercept metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -132,6 +154,8 @@ Key | Description | Type | Default | Required

##### metaflow.move

move metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -143,6 +167,8 @@ Key | Description | Type | Default | Required

##### metaflow.play

play metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -153,6 +179,8 @@ Key | Description | Type | Default | Required

##### metaflow.record_call

record_call metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -164,6 +192,8 @@ Key | Description | Type | Default | Required

##### metaflow.resume

resume metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -172,6 +202,8 @@ Key | Description | Type | Default | Required

##### metaflow.say

say metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -184,6 +216,8 @@ Key | Description | Type | Default | Required

##### metaflow.sound_touch

sound_touch metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -200,6 +234,8 @@ Key | Description | Type | Default | Required

##### metaflow.transfer

transfer metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -211,6 +247,8 @@ Key | Description | Type | Default | Required

##### metaflow.tts

tts metaflow schema

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`children` | | [#/definitions/metaflow_children](#metaflow_children) | | `false`
Expand All @@ -225,11 +263,15 @@ Key | Description | Type | Default | Required

##### metaflow_children

A metaflow child nodes

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------

##### metaflows

Actions applied to a call outside of the normal callflow, initiated by the caller(s)

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`binding_digit` | What DTMF will trigger the collection and analysis of the subsequent DTMF sequence | `string('1', '2', '3', '4', '5', '6', '7', '8', '9', '0', '*', '#')` | `*` | `false`
Expand All @@ -242,6 +284,8 @@ Key | Description | Type | Default | Required

##### notify.callback

Schema for a callback options

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`attempts` | How many attempts without answer will system do | `integer` | | `false`
Expand All @@ -261,52 +305,52 @@ curl -v -X PUT \
http://{SERVER}:8000/v2/accounts
```

#### Remove
#### Fetch

> DELETE /v2/accounts/{ACCOUNT_ID}
> GET /v2/accounts/{ACCOUNT_ID}

```shell
curl -v -X DELETE \
curl -v -X GET \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}
```

#### Fetch
#### Create

> GET /v2/accounts/{ACCOUNT_ID}
> PUT /v2/accounts/{ACCOUNT_ID}

```shell
curl -v -X GET \
curl -v -X PUT \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}
```

#### Patch
#### Change

> PATCH /v2/accounts/{ACCOUNT_ID}
> POST /v2/accounts/{ACCOUNT_ID}

```shell
curl -v -X PATCH \
curl -v -X POST \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}
```

#### Change
#### Patch

> POST /v2/accounts/{ACCOUNT_ID}
> PATCH /v2/accounts/{ACCOUNT_ID}

```shell
curl -v -X POST \
curl -v -X PATCH \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}
```

#### Create
#### Remove

> PUT /v2/accounts/{ACCOUNT_ID}
> DELETE /v2/accounts/{ACCOUNT_ID}

```shell
curl -v -X PUT \
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}
```
Expand Down Expand Up @@ -371,22 +415,22 @@ curl -v -X GET \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/children
```

#### Remove
#### Create

> DELETE /v2/accounts/{ACCOUNT_ID}/reseller
> PUT /v2/accounts/{ACCOUNT_ID}/reseller

```shell
curl -v -X DELETE \
curl -v -X PUT \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/reseller
```

#### Create
#### Remove

> PUT /v2/accounts/{ACCOUNT_ID}/reseller
> DELETE /v2/accounts/{ACCOUNT_ID}/reseller

```shell
curl -v -X PUT \
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/reseller
```
Expand Down
2 changes: 2 additions & 0 deletions applications/crossbar/doc/ref/acls.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#### Schema

Access Control List entries

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`cidr` | Classless Inter-Domain Routing IP notation for use on the ACL | `string` | | `true`
Expand Down
12 changes: 6 additions & 6 deletions applications/crossbar/doc/ref/alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,22 @@ curl -v -X PUT \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/alerts
```

#### Remove
#### Fetch

> DELETE /v2/accounts/{ACCOUNT_ID}/alerts/{ALERT_ID}
> GET /v2/accounts/{ACCOUNT_ID}/alerts/{ALERT_ID}

```shell
curl -v -X DELETE \
curl -v -X GET \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/alerts/{ALERT_ID}
```

#### Fetch
#### Remove

> GET /v2/accounts/{ACCOUNT_ID}/alerts/{ALERT_ID}
> DELETE /v2/accounts/{ACCOUNT_ID}/alerts/{ALERT_ID}

```shell
curl -v -X GET \
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/alerts/{ALERT_ID}
```
Expand Down
2 changes: 2 additions & 0 deletions applications/crossbar/doc/ref/api_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#### Schema

Provides an auth-token via an Account API key

Key | Description | Type | Default | Required
--- | ----------- | ---- | ------- | --------
`api_key` | The Accounts API key | `string(64)` | | `true`
Expand Down
Loading