Skip to content

Commit f76a2a7

Browse files
authored
docs: update deprecation comments to reference IPIP-526 (#1076)
Replace references to stalled IPIP-378 with IPIP-526 which documents the historic Bitswap provider publishing API.
1 parent 0842ad2 commit f76a2a7

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

routing/http/client/client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,9 +339,9 @@ func (c *Client) FindProviders(ctx context.Context, key cid.Cid) (providers iter
339339
return &measuringIter[iter.Result[types.Record]]{Iter: it, ctx: ctx, m: m}, nil
340340
}
341341

342-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
342+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
343343
//
344-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
344+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
345345
func (c *Client) ProvideBitswap(ctx context.Context, keys []cid.Cid, ttl time.Duration) (time.Duration, error) {
346346
if c.identity == nil {
347347
return 0, errors.New("cannot provide Bitswap records without an identity")

routing/http/server/server.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ type DelegatedRouter interface {
7171
// Limit indicates the maximum amount of results to return; 0 means unbounded.
7272
FindProviders(ctx context.Context, cid cid.Cid, limit int) (iter.ResultIter[types.Record], error)
7373

74-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
74+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
7575
//
76-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
76+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
7777
ProvideBitswap(ctx context.Context, req *BitswapWriteProvideRequest) (time.Duration, error)
7878

7979
// FindPeers searches for peers who have the provided [peer.ID].
@@ -95,9 +95,9 @@ type DelegatedRouter interface {
9595
// Deprecated: use DelegatedRouter. ContentRouter will be removed in a future version.
9696
type ContentRouter = DelegatedRouter
9797

98-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
98+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
9999
//
100-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
100+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
101101
type BitswapWriteProvideRequest struct {
102102
Keys []cid.Cid
103103
Timestamp time.Time
@@ -106,9 +106,9 @@ type BitswapWriteProvideRequest struct {
106106
Addrs []multiaddr.Multiaddr
107107
}
108108

109-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
109+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
110110
//
111-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
111+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
112112
type WriteProvideRequest struct {
113113
Protocol string
114114
Schema string

routing/http/types/json/requests.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ import (
66
"github.com/ipfs/boxo/routing/http/types"
77
)
88

9-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
9+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
1010
//
11-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
11+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
1212
type WriteProvidersRequest struct {
1313
Providers []types.Record
1414
}

routing/http/types/json/responses.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ func (r *RecordsArray) UnmarshalJSON(b []byte) error {
6868
return nil
6969
}
7070

71-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
71+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
7272
//
73-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
73+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
7474
type WriteProvidersResponse struct {
7575
ProvideResults []types.Record
7676
}

routing/http/types/record_bitswap.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ func (br *BitswapRecord) GetSchema() string {
3535

3636
var _ Record = &WriteBitswapRecord{}
3737

38-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
38+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
3939
//
40-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
40+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
4141
type WriteBitswapRecord struct {
4242
Schema string
4343
Protocol string
@@ -170,9 +170,9 @@ func (p *WriteBitswapRecord) Verify() error {
170170

171171
var _ Record = &WriteBitswapRecordResponse{}
172172

173-
// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
173+
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
174174
//
175-
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
175+
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
176176
type WriteBitswapRecordResponse struct {
177177
Schema string
178178
Protocol string

0 commit comments

Comments
 (0)