From bec95a1958970d0efc9721a0d8f9e3124f89c740 Mon Sep 17 00:00:00 2001 From: Daniel Norman <1992255+2color@users.noreply.github.com> Date: Tue, 20 Sep 2022 14:41:18 +0200 Subject: [PATCH] docs: deprecate Object API Context: https://github.com/ipfs/go-ipfs/issues/7936 --- docs/core-api/OBJECT.md | 2 ++ docs/core-api/README.md | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/core-api/OBJECT.md b/docs/core-api/OBJECT.md index 3d5667e3d6..bc48225f91 100644 --- a/docs/core-api/OBJECT.md +++ b/docs/core-api/OBJECT.md @@ -1,5 +1,7 @@ # Object API +> ⚠️ Object API is [deprecated](https://github.com/ipfs/go-ipfs/issues/7936), use [FILES](FILES.md) and [DAG](DAG.md) APIs instead. + - [`ipfs.object.new([options])`](#ipfsobjectnewoptions) - [Parameters](#parameters) - [Options](#options) diff --git a/docs/core-api/README.md b/docs/core-api/README.md index 46c0987165..6b058fb8c7 100644 --- a/docs/core-api/README.md +++ b/docs/core-api/README.md @@ -1,11 +1,11 @@ # IPFS Core API -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. +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. This abstraction allows for different implementations including: 1. Full JavaScript native implementation 2. Delgate implementation that invokes another IPFS implementation (e.g., Kubo) -You can use this loose spec as documentation for consuming the core APIs. +You can use this loose spec as documentation for consuming the core APIs. It is broken up into the following sections: @@ -19,7 +19,7 @@ It is broken up into the following sections: * [KEY.md](KEY.md) * [MISCELLANEOUS.md](MISCELLANEOUS.md) * [NAME.md](NAME.md) -* [OBJECT.md](OBJECT.md) +* [OBJECT.md](OBJECT.md) ([deprecated](https://github.com/ipfs/go-ipfs/issues/7936), use the [DAG API](DAG.md) instead) * [PIN.md](PIN.md) * [PUBSUB.md](PUBSUB.md) * [REFS.md](REFS.md)