Skip to content
This repository has been archived by the owner on Apr 29, 2020. It is now read-only.

Commit

Permalink
Added periods, removed errant response, added Attr desc
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Feb 18, 2016
1 parent ec365ca commit cf6f4c2
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,9 @@ Stores input as an IPFS block

In the example provided, the 'test' file has the following contents:

```
hello world
```

#### curl

Expand Down Expand Up @@ -1338,22 +1340,13 @@ Outputs the list of peers that were removed.

# Group cat

Show IPFS object data
Show IPFS object data.

## cat [GET /cat{?arg}]
Retrieves the object named by <ipfs-or-ipns-path> and outputs the data it contains.

+ Parameters
+ arg (string, required) - The path to the IPFS object or objects to be outputted

+ Response 200

+ Headers

```
Transfer-Encoding: chunked
X-Stream-Output: 1
```
+ arg (string, required) - The path to the IPFS object or objects to be outputted.

+ Request Without Arguments

Expand All @@ -1379,6 +1372,8 @@ Retrieves the object named by <ipfs-or-ipns-path> and outputs the data it contai

+ Attributes (string)

This is the raw content of the file.

+ Body

```
Expand Down Expand Up @@ -1463,13 +1458,16 @@ Retrieves the object named by <ipfs-or-ipns-path> and outputs the data it contai
"Message": "this dag node is a directory",
"Code": 0
}
```

+ Request With Valid Argument

In this request, 'QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o' is the hash for a file, 'test',
with the following contents

```
hello world
```

#### curl

Expand Down

0 comments on commit cf6f4c2

Please sign in to comment.