Skip to content

Commit

Permalink
copy edits
Browse files Browse the repository at this point in the history
Co-authored-by: Padraic Shafer <[email protected]>
  • Loading branch information
danielballan and padraic-shafer authored Nov 29, 2023
1 parent c7edd9d commit b0ff67b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/source/reference/http-api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit b0ff67b

Please sign in to comment.