Skip to content

Commit

Permalink
clean up snake_names in ref docs (2600hz#3385)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesaimonetti authored and fenollp committed Mar 7, 2017
1 parent 26d3a78 commit 9b26d15
Show file tree
Hide file tree
Showing 52 changed files with 541 additions and 125 deletions.
4 changes: 2 additions & 2 deletions applications/crossbar/doc/access_lists.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### Access_lists
### Access Lists

SBC-level per-account and per-device access lists allow setting individual IP-based access filtering rules which
significantly increases security for users working on-premise.

Rules can be applied at account level or at individual device level

#### About Access_lists
#### About Access Lists

`access_lists` API works at the level of both `accounts` and `devices` documents.

Expand Down
4 changes: 2 additions & 2 deletions applications/crossbar/doc/api_authentication.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
### Api_auth
### API Authentication

Generating an auth token from your API token

Use your account's API token to instruct Crossbar to create an authentication token to be used on subsequent requests requiring authentication.

#### About
#### About API Authentication

Get your API key for your account:

Expand Down
4 changes: 2 additions & 2 deletions applications/crossbar/doc/apps_link.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Apps_link
### Apps Link

#### About Apps_link
#### About Apps Link

#### Schema

Expand Down
64 changes: 62 additions & 2 deletions applications/crossbar/doc/auth.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,67 @@
### Auth
### Authentication

#### About Auth
#### About Authentication

#### Schema



#### Fetch

> GET /v2/auth/links
```shell
curl -v -X GET \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/auth/links
```

#### Change

> POST /v2/auth/links
```shell
curl -v -X POST \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/auth/links
```

#### Remove

> DELETE /v2/auth/links
```shell
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/auth/links
```

#### Create

> PUT /v2/auth/callback
```shell
curl -v -X PUT \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/auth/callback
```

#### Create

> PUT /v2/auth/authorize
```shell
curl -v -X PUT \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/auth/authorize
```

#### Fetch

> GET /v2/auth/tokeninfo
```shell
curl -v -X GET \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/auth/tokeninfo
```
4 changes: 2 additions & 2 deletions applications/crossbar/doc/call_inspector.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Call_inspector
### Call Inspector

#### About Call_inspector
#### About Call Inspector

The Call Inspector Crossbar resource allows the client to query and inspect data related to the Call Inspector application.

Expand Down
4 changes: 2 additions & 2 deletions applications/crossbar/doc/contact_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Contact_list
### Contact List

#### About Contact_list
#### About Contact List

#### Schema

Expand Down
84 changes: 82 additions & 2 deletions applications/crossbar/doc/global_provisioner_templates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,87 @@
### Global_provisioner_templates
### Global Provisioner Templates

#### About Global_provisioner_templates
#### About Global Provisioner Templates

#### Schema



#### Fetch

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

#### Create

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

#### Fetch

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

#### Change

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

#### Remove

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

#### Fetch

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

#### Change

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

#### Remove

> DELETE /v2/accounts/{ACCOUNT_ID}/global_provisioner_templates/{TEMPLATE_ID}/image
```shell
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/global_provisioner_templates/{TEMPLATE_ID}/image
```
14 changes: 12 additions & 2 deletions applications/crossbar/doc/google_auth.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
### Google_auth
### Google Authentication

#### About Google_auth
#### About Google Authentication

#### Schema



#### Create

> PUT /v2/google_auth
```shell
curl -v -X PUT \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/google_auth
```
14 changes: 12 additions & 2 deletions applications/crossbar/doc/ip_auth.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
### Ip_auth
### IP Authentication

#### About Ip_auth
#### About IP Authentication

#### Schema



#### Create

> PUT /v2/ip_auth
```shell
curl -v -X PUT \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/ip_auth
```
84 changes: 82 additions & 2 deletions applications/crossbar/doc/local_provisioner_templates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,87 @@
### Local_provisioner_templates
### Local Provisioner Templates

#### About Local_provisioner_templates
#### About Local Provisioner Templates

#### Schema



#### Fetch

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

#### Create

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

#### Fetch

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

#### Change

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

#### Remove

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

#### Fetch

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

#### Change

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

#### Remove

> DELETE /v2/accounts/{ACCOUNT_ID}/local_provisioner_templates/{TEMPLATE_ID}/image
```shell
curl -v -X DELETE \
-H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/local_provisioner_templates/{TEMPLATE_ID}/image
```
4 changes: 2 additions & 2 deletions applications/crossbar/doc/parked_calls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Parked calls
### Parked Calls

#### About Parked calls
#### About Parked Calls

#### Schema

Expand Down
2 changes: 1 addition & 1 deletion applications/crossbar/doc/phone_numbers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Phone Numbers

#### About Phone_numbers
#### About Phone Numbers

The 2600hz mobile API set: manage numbers.

Expand Down
2 changes: 2 additions & 0 deletions applications/crossbar/doc/port_requests.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
### Port Requests

#### About Port Requests

Manage and track number port requests through the Port Requests API.

A port request can be in one of five **states**:
Expand Down
2 changes: 2 additions & 0 deletions applications/crossbar/doc/rate_limits.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
### Rate Limits

#### About Rate Limits

The rate-limits API allows setting per-second and per-minute incoming SIP packets rate limits for devices and whole accounts (realms) that can be used at SBC level. The system level packet rate limits can also be set to protect the whole cluster.

Expand Down
4 changes: 2 additions & 2 deletions applications/crossbar/doc/ref/access_lists.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Access_lists
### Access Lists

#### About Access_lists
#### About Access Lists

#### Schema

Expand Down
4 changes: 2 additions & 2 deletions applications/crossbar/doc/ref/api_auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Api_auth
### API Authentication

#### About Api_auth
#### About API Authentication

#### Schema

Expand Down
Loading

0 comments on commit 9b26d15

Please sign in to comment.