club.fellas.v0.poll.definition

cam.fellas.club

Documentation

A poll posted within the fella space.

main record

A poll posted within the fella space.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

optionType string Optional

What kind of thing the ballot options are.

Known values: text, movie, book
Default: text
options array of ref club.fellas.v0.poll.defs#option Optional

Required (>=2 entries) when optionsMode is 'author'; omitted when 'group' (participants contribute their own via club.fellas.v0.poll.option instead). The author-mode requirement is enforced by the application, not this schema.

maxLength: 32 itemsminLength: 2 items
optionsMode string Required

author = only the poll author's own options (the inline array above) are valid. group = any listed participant may contribute their own option via club.fellas.v0.poll.option.

Known values: author, group
question string Required

No description available.

maxLength: 1000 bytes
status string Optional

Defaults to open if omitted. Set to closed by the author (via putRecord) to stop accepting new votes and drop out of the default poll listing.

Known values: open, closed
tallyType string Required

single = pick exactly one option. ranked = order some or all options best-to-worst (IRV tallying).

Known values: single, ranked
transparency string Required

open = votes (and, in group-mode, option authorship) attributed to voter, visible as cast. anonymous = identity links never shown by the client. sealed = nothing shown until every voter has published a poll.reveal record for this poll.

Known values: open, anonymous, sealed
View raw schema 
{
  "description": "A poll posted within the fella space.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "optionType": {
        "default": "text",
        "description": "What kind of thing the ballot options are.",
        "knownValues": [
          "text",
          "movie",
          "book"
        ],
        "type": "string"
      },
      "options": {
        "description": "Required (>=2 entries) when optionsMode is 'author'; omitted when 'group' (participants contribute their own via club.fellas.v0.poll.option instead). The author-mode requirement is enforced by the application, not this schema.",
        "items": {
          "ref": "club.fellas.v0.poll.defs#option",
          "type": "ref"
        },
        "maxLength": 32,
        "minLength": 2,
        "type": "array"
      },
      "optionsMode": {
        "description": "author = only the poll author's own options (the inline array above) are valid. group = any listed participant may contribute their own option via club.fellas.v0.poll.option.",
        "knownValues": [
          "author",
          "group"
        ],
        "type": "string"
      },
      "question": {
        "maxLength": 1000,
        "type": "string"
      },
      "status": {
        "description": "Defaults to open if omitted. Set to closed by the author (via putRecord) to stop accepting new votes and drop out of the default poll listing.",
        "knownValues": [
          "open",
          "closed"
        ],
        "type": "string"
      },
      "tallyType": {
        "description": "single = pick exactly one option. ranked = order some or all options best-to-worst (IRV tallying).",
        "knownValues": [
          "single",
          "ranked"
        ],
        "type": "string"
      },
      "transparency": {
        "description": "open = votes (and, in group-mode, option authorship) attributed to voter, visible as cast. anonymous = identity links never shown by the client. sealed = nothing shown until every voter has published a poll.reveal record for this poll.",
        "knownValues": [
          "open",
          "anonymous",
          "sealed"
        ],
        "type": "string"
      }
    },
    "required": [
      "question",
      "tallyType",
      "transparency",
      "optionsMode",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@