Permalink
Browse files

tweeks to carlo doc testing updates

  • Loading branch information...
1 parent da50a00 commit f0189ea5422710d14a084679007c14535f2063aa @soldair soldair committed Feb 28, 2014
Showing with 18 additions and 14 deletions.
  1. +18 −14 carlo.md
View
@@ -1,3 +1,6 @@
+
+### index
+
* <a href="#login">login</a>
* <a href="#register">register</a>
* <a href="#account">account details</a>
@@ -100,7 +103,7 @@ curl 'https://api.pinocc.io/v1/troops?token=7fc11b7554f0cd303bad94eb0eb36e2d'
```
<a name="troop-get"></a>
-###GET /v1/1
+###GET /v1/{troop id}
get the data for your first troop
@@ -117,7 +120,7 @@ curl 'https://api.pinocc.io/v1/1?token=7fc11b7554f0cd303bad94eb0eb36e2d'
```
<a name="troop-patch"></a>
-###PATCH /v1/1
+###PATCH /v1/{troop id}
update data associated with your troop
@@ -129,15 +132,15 @@ curl -X PATCH --data "name=old sport" 'https://api.pinocc.io/v1/1?token=7fc11b75
```
<a name="troop-del"></a>
-###DELETE /v1/1
+###DELETE /v1/{troop id}
```sh
curl -X DELETE 'https://api.pinocc.io/v1/1?token=7fc11b7554f0cd303bad94eb0eb36e2d'
```
<a name="new-scout"></a>
-###POST /v1/1/scout
+###POST /v1/{troop id}/scout
add a new scout to your troop
@@ -153,7 +156,7 @@ curl -X POST 'https://api.pinocc.io/v1/1/scout?token=7fc11b7554f0cd303bad94eb0eb
```
<a name="scouts"></a>
-###GET /v1/1/scouts
+###GET /v1/{troop id}/scouts
get all of the scouts in your troop. returns an object keyed off of scout id or false if no scouts are associated.
@@ -169,7 +172,7 @@ curl 'https://api.pinocc.io/v1/1/scouts?token=7fc11b7554f0cd303bad94eb0eb36e2d'
```
<a name="scout-get"></a>
-###GET /v1/1/1
+###GET /v1/{troop id}/{scout id}
get the data for your a scout.
@@ -185,7 +188,7 @@ curl 'https://api.pinocc.io/v1/1/1?token=7fc11b7554f0cd303bad94eb0eb36e2d'
```
<a name="scout-patch"></a>
-###PATCH /v1/1/1
+###PATCH /v1/{troop id}/{scout id}
update data in your scout
@@ -204,15 +207,15 @@ curl -X PATCH --data "name=old yeller" 'https://api.pinocc.io/v1/1/1?token=7fc11
```
<a name="scout-del"></a>
-###DELETE /v1/1/1
+###DELETE /v1/{troop id}/{scout id}
```sh
curl -X DELETE 'https://api.pinocc.io/v1/1/1?token=7fc11b7554f0cd303bad94eb0eb36e2d'
```
<a name="commands"></a>
-###GET /v1/1/1/commands
+###GET /v1/{troop id}/{scout id}/commands
print a list of available bitlash commands
@@ -233,15 +236,16 @@ curl 'https://api.pinocc.io/v1/1/1/commands?token=7fc11b7554f0cd303bad94eb0eb36
```
<a name="command"><a>
-###GET /v1/1/1/command/:command
-
-GET /v1/1/1/command?command=command
+###GET /v1/{troop id}/{scout id}/command/:command
-POST /v1/1/1/command data: command=command
+GET /v1/{troop id}/{scout id}/command?command=command
+POST /v1/{troop id}/{scout id}/command data: command=command
command may be passed as a querystring key or a post data key named "command"
+post data may be query string formatted or json
+
```sh
@@ -259,4 +263,4 @@ curl 'https://api.pinocc.io/v1/1/1/command/led.report?token=7fc11b7554f0cd303ba
{"error":{"code":500,"message":"command timed out. troop:7fc11b7554f0cd303bad94eb0eb36e2d, scout:1, command:led.report"},"data":{"reply":""}}
-```
+```

0 comments on commit f0189ea

Please sign in to comment.