Skip to content

Commit 76ae33a

Browse files
authored
chore: deprecate /api/v0/dns (#8893)
Closes #8607
1 parent fd7af6a commit 76ae33a

File tree

2 files changed

+9
-33
lines changed

2 files changed

+9
-33
lines changed

core/commands/dns.go

+7-30
Original file line numberDiff line numberDiff line change
@@ -17,40 +17,17 @@ const (
1717
)
1818

1919
var DNSCmd = &cmds.Command{
20+
Status: cmds.Deprecated, // https://github.com/ipfs/go-ipfs/issues/8607
2021
Helptext: cmds.HelpText{
21-
Tagline: "Resolve DNS links.",
22+
Tagline: "Resolve DNSLink records.",
2223
ShortDescription: `
23-
Multihashes are hard to remember, but domain names are usually easy to
24-
remember. To create memorable aliases for multihashes, DNS TXT
25-
records can point to other DNS links, IPFS objects, IPNS keys, etc.
26-
This command resolves those links to the referenced object.
27-
`,
28-
LongDescription: `
29-
Multihashes are hard to remember, but domain names are usually easy to
30-
remember. To create memorable aliases for multihashes, DNS TXT
31-
records can point to other DNS links, IPFS objects, IPNS keys, etc.
32-
This command resolves those links to the referenced object.
33-
34-
Note: This command can only recursively resolve DNS links,
35-
it will fail to recursively resolve through IPNS keys etc.
36-
For general-purpose recursive resolution, use ipfs name resolve -r.
37-
38-
For example, with this DNS TXT record:
39-
40-
> dig +short TXT _dnslink.ipfs.io
41-
dnslink=/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy
42-
43-
The resolver will give:
44-
45-
> ipfs dns ipfs.io
46-
/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy
24+
This command can only recursively resolve DNSLink TXT records.
25+
It will fail to recursively resolve through IPNS keys etc.
4726
48-
The resolver can recursively resolve:
27+
DEPRECATED: superseded by 'ipfs resolve'
4928
50-
> dig +short TXT recursive.ipfs.io
51-
dnslink=/ipns/ipfs.io
52-
> ipfs dns -r recursive.ipfs.io
53-
/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy
29+
For general-purpose recursive resolution, use 'ipfs resolve -r'.
30+
It will work across multiple DNSLinks and IPNS keys.
5431
`,
5532
},
5633

core/commands/root.go

+2-3
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,13 @@ TEXT ENCODING COMMANDS
5151
ADVANCED COMMANDS
5252
daemon Start a long-running daemon process
5353
mount Mount an IPFS read-only mount point
54-
resolve Resolve any type of name
54+
resolve Resolve any type of content path
5555
name Publish and resolve IPNS names
5656
key Create and list IPNS name keypairs
57-
dns Resolve DNS links
5857
pin Pin objects to local storage
5958
repo Manipulate the IPFS repository
6059
stats Various operational stats
61-
p2p Libp2p stream mounting
60+
p2p Libp2p stream mounting (experimental)
6261
filestore Manage the filestore (experimental)
6362
6463
NETWORK COMMANDS

0 commit comments

Comments
 (0)