Skip to main content

Module pages

Module pages 

Source
Expand description

GET /api/v2/pages/ + GET /api/v2/pages/{id}/.

Lists + retrieves published pages over JSON.

Every surface here is viewer-aware. detail runs crate::view_restriction_guard and answers a denial with 401 / 403; list (and its ?child_of= / ?descendant_of= / ?ancestor_of= filters), find and the children summaries all drop what the caller may not see via crate::view_restriction::denied_page_ids. find answers a gated page and a missing one identically, so it cannot be used to probe for hidden URLs.

Structs§

DetailQuery
Query for the page detail endpoint.
FindQuery
Query string for GET /api/v2/pages/find/.
PageFilters
Per-endpoint filters layered on top of crate::api::query::ListQuery.
PageListQuery
Combined query string for GET /api/v2/pages/.

Constants§

MAX_CHILDREN
Most children a detail response will inline.

Functions§

detail
GET /api/v2/pages/{id}/
detail_object_with_type
Build the canonical page-detail object.
find
GET /api/v2/pages/find/?html_path=/about — resolve a public URL path to its page and 302-redirect to the detail endpoint. Resolves published pages only; view restrictions are enforced by the detail endpoint the client follows to (find itself doesn’t pre-check them).
list
GET /api/v2/pages/
list_inner
The body of GET /api/v2/pages/.