Skip to content

Site

A Site is a website as a Thing: its Pages, navigation, and Brand, served on one or more Domains.

Properties

PropertyTypeRequiredDescription
navigationjsonThe menus that link its Pages.
Inherited from Interface: 3 properties
PropertyTypeRequiredDescription
kindstringrequiredOne of api, mcp, cli, sdk, site, app, docs, or webhooks.
pathstringWhere it is mounted on its Domain, such as /api.
conformsTojsonThe Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/sites/site_1",
  "$type": "Site",
  "kind": "api",
  "path": "/",
  "conformsTo": {
    "standard": "openai-chat",
    "operations": {
      "chat.completions.create": "Listing.write"
    }
  },
  "navigation": {}
}

Relationships

  • A Site contains many Pages: a Site serves its Pages, each at its own path. contains, inverse containedIn.
  • A Site is hosted at many Domains: a Site answers on one or more Domains; each Domain serves one Site. hostedAt, inverse hosts.
  • A Site includes one Portal: a Site includes one Portal, the signed-in part where each Customer sees only their own records. includes, inverse includedIn.
  • A Site is styled by one Brand: a Site renders one Brand’s name, voice and Theme. styledBy, inverse styles.
  • A Site has many Visits: each Visit arrives on one Site. visits, inverse lands.

Verbs

  1. createCreates a Site.
    POST /{namespace}/sitesdoSite.created
  2. getReturns one Site by id.
    GET /{namespace}/sites/{id}readNo Event
  3. listReturns Sites, newest first, one page at a time.
    GET /{namespace}/sitesreadNo Event
  4. updateChanges the given properties of a Site.
    PATCH /{namespace}/sites/{id}doSite.updated
  5. deleteDeletes a Site; its history is kept.
    DELETE /{namespace}/sites/{id}doSite.deleted
  6. publishPublish puts a Site’s current Pages live on its Domains, under its Brand.
    POST /{namespace}/sites/{site}/publishdoSite.published

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Site.createYesYesYesNo
Site.getYesYesYesYes
Site.listYesYesYesYes
Site.updateYesYesYesNo
Site.deleteYesYesYesNo
Site.publishYesYesYesNo

Call it

Text
Publish the site “Algebra session”.

Example

A home-inspector directory is a Site with home, city, inspector, and pricing Pages under one Brand, served on inspectfinder.com and www.inspectfinder.com.