Page
A Page is an addressable page of a Site, of a named type such as pricing, about one Thing or each member of a Collection.
A Template renders it.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
path | string | required | The path under its Site, such as /. |
kind | string | The page type, such as landing, pricing, or terms. | |
from | string | Lineage: the slot it compiles from, as Hypothesis#<slot>@v<version>. |
Object
{
"$id": "https: //api.sb/ shiftnote.app/ pages/ page_1",
"$type": "Page",
"path": "/",
"kind": "landing",
"from": "Hypothesis#approach@v1"
}Relationships
- A Page is contained in one Site: a Site serves its Pages, each at its own path.
containedIn, inversecontains. - A Page displays many pieces of Content: Pages display published Content; one piece appears on many Pages.
displays, inversedisplayedOn. - A Page embeds many Forms: Forms sit on Pages; one Form appears on many Pages.
embeds, inverseembeddedIn. - A Page is rendered with one Template: a Template fills one Page per Thing or per member of a Collection.
renderedWith, inverserenders. - A Page targets many Keywords: a Page is written to rank for, or be cited on, its Keywords.
targets, inversetargetedBy. - A Page uses many Components: a Page is assembled from Components, each filled from records.
uses, inverseusedOn.
Verbs
createCreates a Page.POST /{namespace}/pagesgetReturns one Page by id.GET /{namespace}/pages/{id}listReturns Pages, newest first, one page at a time.GET /{namespace}/pagesupdateChanges the given properties of a Page.PATCH /{namespace}/pages/{id}deleteDeletes a Page; its history is kept.DELETE /{namespace}/pages/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Page.create | Yes | Yes | Yes | No |
Page.get | Yes | Yes | Yes | Yes |
Page.list | Yes | Yes | Yes | Yes |
Page.update | Yes | Yes | Yes | No |
Page.delete | Yes | Yes | Yes | No |
Call it
Add a page to RouteWise.Example
/inspectors/ is a Page of kind city on a home-inspector directory, one per member of a Collection of cities. Adding an inspector updates it with no edit.