From b0ff67b2b90ac16883733ab1e2d5ecee7972ba4c Mon Sep 17 00:00:00 2001 From: Dan Allan Date: Wed, 29 Nov 2023 13:21:41 -0500 Subject: [PATCH] copy edits Co-authored-by: Padraic Shafer <76011594+padraic-shafer@users.noreply.github.com> --- docs/source/reference/http-api-overview.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/reference/http-api-overview.md b/docs/source/reference/http-api-overview.md index 3f15cd832..21b466592 100644 --- a/docs/source/reference/http-api-overview.md +++ b/docs/source/reference/http-api-overview.md @@ -25,12 +25,15 @@ the data, in various forms. For example, data access routes ``GET /api/v1/array/block/{path}``, ``GET /api/v1/array/full/{path}``, and ``GET /api/v1/table/partition/{path}`` -provide options for slicing and sub-selection specific to arrays and table. +provide options for slicing and sub-selection specific to arrays and tables. Generic clients, like a web browser, should use the "full" routes, which send the entire (sliced) result in one response. More sophisticated clients with some knowledge of Tiled may use the other routes, which enable parallel chunk-based access. +The ``GET /api/v1/container/full/{path}`` route + provides all the metadata and data below a given directory. This route also works for other container-like data structures. + The root route, `GET /api/v1/` provides general information about the server and the formats and authentication providers it supports.