Skip to content

Commit 1adaf28

Browse files
committed
Rename to http-path
1 parent 9d3dd76 commit 1adaf28

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

protocols/httppath.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `httppath`
1+
# `http-path`
22

33
This protocol encodes an HTTP Path to a resource. In the string representation,
44
the path is encoded in a way consistent with a single URI Path segment per [RFC 3986 Section
@@ -13,25 +13,25 @@ representation to avoid ambiguities over which characters were escaped.
1313

1414
The following is a table of examples converting some common HTTP paths to their Multiaddr string form.
1515

16-
| HTTP Path | Multiaddr string form |
17-
| --------------- | -------------------------------- |
18-
| / | n/a. This is implied. |
19-
| /user | `/httppath/user` |
20-
| /api/v0/login | `/httppath/api%2Fv0%2Flogin` |
21-
| /tmp/foo/../bar | `/httppath/tmp%2Ffoo%2F..%2Fbar` |
22-
| a%20space | `/httppath/a%2520space` |
23-
| a%2Fslash | `/httppath/a%252Fslash` |
16+
| HTTP Path | Multiaddr string form |
17+
| --------------- | --------------------------------- |
18+
| / | n/a. This is implied. |
19+
| /user | `/http-path/user` |
20+
| /api/v0/login | `/http-path/api%2Fv0%2Flogin` |
21+
| /tmp/foo/../bar | `/http-path/tmp%2Ffoo%2F..%2Fbar` |
22+
| a%20space | `/http-path/a%2520space` |
23+
| a%2Fslash | `/http-path/a%252Fslash` |
2424

2525
## Usage
2626

27-
`/httppath` should be appended to the end of an existing multiaddr, including after the peer id component (p2p). As an example, here's a multiaddr referencing the `.well-known/libp2p` HTTP resource along with a way to reach that peer:
27+
`/http-path` should be appended to the end of an existing multiaddr, including after the peer id component (p2p). As an example, here's a multiaddr referencing the `.well-known/libp2p` HTTP resource along with a way to reach that peer:
2828

2929
```
30-
/ip4/1.2.3.4/tcp/443/tls/http/p2p/12D.../httppath/.well-known%2Flibp2p
30+
/ip4/1.2.3.4/tcp/443/tls/http/p2p/12D.../http-path/.well-known%2Flibp2p
3131
```
3232

33-
The `/httppath` component can also be appended to just the `/p2p/...` component, and rely on a separate peer discovery mechanism to actually identify the peer's address:
33+
The `/http-path` component can also be appended to just the `/p2p/...` component, and rely on a separate peer discovery mechanism to actually identify the peer's address:
3434

3535
```
36-
/p2p/12D.../httppath/.well-known%2Flibp2p
36+
/p2p/12D.../http-path/.well-known%2Flibp2p
3737
```

0 commit comments

Comments
 (0)