Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit bec95a1

Browse files
2colorlidel
authored andcommitted
docs: deprecate Object API
Context: ipfs/kubo#7936
1 parent b545688 commit bec95a1

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/core-api/OBJECT.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Object API <!-- omit in toc -->
22

3+
> ⚠️ Object API is [deprecated](https://github.com/ipfs/go-ipfs/issues/7936), use [FILES](FILES.md) and [DAG](DAG.md) APIs instead.
4+
35
- [`ipfs.object.new([options])`](#ipfsobjectnewoptions)
46
- [Parameters](#parameters)
57
- [Options](#options)

docs/core-api/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# IPFS Core API
22

3-
This directory contains the description of the core JS IPFS API. In order to be considered "valid", a JS IPFS core implementation must expose the API described here.
3+
This directory contains the description of the core JS IPFS API. In order to be considered "valid", a JS IPFS core implementation must expose the API described here.
44
This abstraction allows for different implementations including:
55
1. Full JavaScript native implementation
66
2. Delgate implementation that invokes another IPFS implementation (e.g., Kubo)
77

8-
You can use this loose spec as documentation for consuming the core APIs.
8+
You can use this loose spec as documentation for consuming the core APIs.
99

1010
It is broken up into the following sections:
1111

@@ -19,7 +19,7 @@ It is broken up into the following sections:
1919
* [KEY.md](KEY.md)
2020
* [MISCELLANEOUS.md](MISCELLANEOUS.md)
2121
* [NAME.md](NAME.md)
22-
* [OBJECT.md](OBJECT.md)
22+
* [OBJECT.md](OBJECT.md) ([deprecated](https://github.com/ipfs/go-ipfs/issues/7936), use the [DAG API](DAG.md) instead)
2323
* [PIN.md](PIN.md)
2424
* [PUBSUB.md](PUBSUB.md)
2525
* [REFS.md](REFS.md)

0 commit comments

Comments
 (0)