sh.diffuse.output.facet

tokono.ma

Documentation

main record

No description available.

Properties

cid string Optional

A DASL CID representing the UTF8 encoded HTML (raw 0x55 codec)

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

enabled boolean Optional

Whether the facet is enabled or not

Default: true
favourite boolean Optional

Whether the facet is favourited (shown at the top) or not. Some facets may be more important to the user than others.

Default: false
html string Optional

The UTF8 HTML string that makes up the facet

id string Required

A unique identifier

kind string Optional

A facet is by default interactive, but headless 'prelude' facets may also be created, these run before any main interactive facet is loaded.

Allowed: interactive, prelude
Default: interactive
name string Required

No description available.

tags array of string Optional

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string Optional

An optional URI that points at the facet; can be used to update this artifact

View raw schema 
{
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "id",
      "name"
    ],
    "properties": {
      "id": {
        "type": "string",
        "description": "A unique identifier"
      },
      "cid": {
        "type": "string",
        "description": "A DASL CID representing the UTF8 encoded HTML (raw 0x55 codec)"
      },
      "uri": {
        "type": "string",
        "description": "An optional URI that points at the facet; can be used to update this artifact"
      },
      "html": {
        "type": "string",
        "description": "The UTF8 HTML string that makes up the facet"
      },
      "kind": {
        "enum": [
          "interactive",
          "prelude"
        ],
        "type": "string",
        "default": "interactive",
        "description": "A facet is by default interactive, but headless 'prelude' facets may also be created, these run before any main interactive facet is loaded."
      },
      "name": {
        "type": "string"
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "enabled": {
        "type": "boolean",
        "default": true,
        "description": "Whether the facet is enabled or not"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "favourite": {
        "type": "boolean",
        "default": false,
        "description": "Whether the facet is favourited (shown at the top) or not. Some facets may be more important to the user than others."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string"
      }
    }
  }
}

Lexicon Garden

@