Skip to content

Reference

These pages state what each interface accepts and returns.

  • HTTP API: the viewer, session and control planes, from the OpenAPI description.
  • Wire framing: the framed Arrow bodies of POST /v1/viewport, POST /v1/artifacts/viewport, POST /v1/items, POST /v1/artifacts and POST /v1/aggregate, with decoders in Python and JavaScript.
  • Capabilities: which route, function, method or command performs each core capability on each of the four surfaces.
  • CLI: the mosaica command and its subcommands.
  • mosaica.toml: the deployment file, which says where the bundle is and how the server listens and bounds its work.
  • schema.toml: the schema, which says what a build reads and what each view, vocabulary, attribute and layer is.
  • Python client: the mosaica package.
  • TypeScript client: the @mosaicajs/client package.
  • Components: the web components, their attributes, events and styling.