From 5e306211f42ddb379894f0fd2b9391a119996f7f Mon Sep 17 00:00:00 2001 From: James Prior Date: Fri, 22 Sep 2023 18:32:23 +0100 Subject: [PATCH] docs: API quick links [skip ci] --- docs/docs/README_API.md | 9 ++++++++- docs/docs/guides/json-patch.md | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/docs/README_API.md b/docs/docs/README_API.md index e7310d9..1d5ef4b 100644 --- a/docs/docs/README_API.md +++ b/docs/docs/README_API.md @@ -1,3 +1,10 @@ # JSON P3 API Documentation -TODO: +Welcome to the API documentation for JSON P3. Also see the [quick start guide](/quick-start) for an introduction to using JSON P3. + +## API Quick Links + +- [JSONPathEnvironment](/api/classes/jsonpath.JSONPathEnvironment) +- [JSONPathEnvironment Options](/api/namespaces/jsonpath#jsonpathenvironmentoptions) +- [JSONPathNodeList](/api/classes/jsonpath.JSONPathNodeList) +- [JSONPathNode](/api/classes/jsonpath.JSONPathNode) diff --git a/docs/docs/guides/json-patch.md b/docs/docs/guides/json-patch.md index 5a4b1b1..5afdf24 100644 --- a/docs/docs/guides/json-patch.md +++ b/docs/docs/guides/json-patch.md @@ -1,6 +1,6 @@ # JSON Patch -[JSON Patch](./quick-start.md#json-patch) ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)) is a standard for describing update operations to perform on JSON-like data. Each operation includes, at least, an `op` string and a `path`, which is a [JSON Pointer](./json-pointer.md). +JSON Patch ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)) is a standard for describing update operations to perform on JSON-like data. Each operation includes, at least, an `op` string and a `path`, which is a [JSON Pointer](./json-pointer.md). Use [`jsonpatch.apply(ops, data)`](../api/namespaces/jsonpatch.md#apply) to apply _ops_ to _data_, where _ops_ should be an array of [`OpObject`s](../api/namespaces/jsonpatch.md#opobject), as per RFC 6902. Patch operation are applied sequentially and, unless the target JSON document's root value is replaced, **data is modified in place**.