work.lexical.review

lexical.work

Documentation

A record representing a review of a work.

main record

A record representing a review of a work.

Record Key tid Timestamp-based ID

Properties

action string at-uri Optional

AT URI of the action this review is tied to.

maxLength: 2048 bytes
rating string at-uri Optional

AT URI of a rating associated with this review.

maxLength: 2048 bytes
text string Required

The review text.

maxLength: 10240 bytesmaxGraphemes: 20480 graphemes
work string at-uri Required

AT URI of the work being reviewed.

maxLength: 2048 bytes
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "work",
      "text"
    ],
    "properties": {
      "text": {
        "type": "string",
        "required": true,
        "maxLength": 10240,
        "description": "The review text.",
        "maxGraphemes": 20480
      },
      "work": {
        "type": "string",
        "format": "at-uri",
        "required": true,
        "maxLength": 2048,
        "description": "AT URI of the work being reviewed."
      },
      "action": {
        "type": "string",
        "format": "at-uri",
        "maxLength": 2048,
        "description": "AT URI of the action this review is tied to."
      },
      "facets": {
        "type": "array",
        "items": {
          "ref": "social.lexical.richtext.facet",
          "type": "ref",
          "nullable": false
        },
        "nullable": false,
        "required": false
      },
      "rating": {
        "type": "string",
        "format": "at-uri",
        "maxLength": 2048,
        "description": "AT URI of a rating associated with this review."
      }
    }
  },
  "description": "A record representing a review of a work."
}

Lexicon Garden

@