Skip to content

Commit

Permalink
fix: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Arqu committed May 31, 2022
1 parent b721366 commit 89a5f4d
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions iroh-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ A rust implementation of an IPFS gateway.

## Endpoints

| Endpoint | Flag | Description | Default |
|-----------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------|------------|
| `/ipfs/:cid` & `/ipfs/:cid/:path` | `?format={"", "fs", "raw", "car", "html"}` | Specifies the serving format & content-type | `""/fs` |
| Endpoint | Flag | Description | Default |
|-----------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------|-------------|
| `/ipfs/:cid` & `/ipfs/:cid/:path` | `?format={"", "fs", "raw", "car"}` | Specifies the serving format & content-type | `""/fs` |
| | `?filename=DESIRED_FILE_NAME` | Specifies a filename for the attachment | `{cid}.bin` |
| | `?download={true, false}` | Sets content-disposition to attachment, browser prompts to save file instead of loading | `false` |
| | `?download={true, false}` | Sets content-disposition to attachment, browser prompts to save file instead of loading | `false` |
| | `?force_dir={true, false}` | Lists unixFS directories even if they contain an `index.html` file | `false` |
| | `?uri=ENCODED_URL` | Query parameter to handle navigator.registerProtocolHandler Web API ie. ipfs:// | `""` |

0 comments on commit 89a5f4d

Please sign in to comment.