garden.lexicon.dazzling-boarfish.rating.scale

tynanpurdy.com

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 1024 bytes
documentation string uri Optional

Optional URI linking to further documentation about this scale (e.g. methodology, citations).

maxLength: 1024 bytes
langs array of string language Optional

BCP-47 tag(s) the name/description/option labels in this scale are written in.

name string Required

No description available.

maxLength: 256 bytes
View raw schema
{
  "key": "tid",
  "record": {
    "properties": {
      "code": {
        "refs": [
          "#nominal",
          "#ordinal",
          "#interval",
          "#ratio"
        ],
        "type": "union"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "maxLength": 1024,
        "type": "string"
      },
      "documentation": {
        "description": "Optional URI linking to further documentation about this scale (e.g. methodology, citations).",
        "format": "uri",
        "maxLength": 1024,
        "type": "string"
      },
      "langs": {
        "description": "BCP-47 tag(s) the name/description/option labels in this scale are written in.",
        "items": {
          "format": "language",
          "type": "string"
        },
        "maxItems": 3,
        "type": "array"
      },
      "name": {
        "maxLength": 256,
        "type": "string"
      }
    },
    "required": [
      "name",
      "code"
    ],
    "type": "object"
  },
  "type": "record"
}
interval object

No description available.

Properties

max integer Required

No description available.

maxLabel string Optional

Optional label for the maximum value.

maxLength: 128 bytes
maxLabelImage object Optional

Optional image for the maximum endpoint (blob reference).

min integer Required

No description available.

minLabel string Optional

Optional label for the minimum value.

maxLength: 128 bytes
minLabelImage object Optional

Optional image for the minimum endpoint (blob reference).

unit string Optional

No description available.

maxLength: 64 bytes
unitsPerWhole integer Required

Divide the stored integer by this to get the value in `unit`s. Any positive integer, not just a power of 10. Choose min/max directly in the smallest (or coarsest) legal increment — every integer between min and max is then a valid value, by construction.

minimum: 1
View raw schema
{
  "properties": {
    "max": {
      "type": "integer"
    },
    "maxLabel": {
      "description": "Optional label for the maximum value.",
      "maxLength": 128,
      "type": "string"
    },
    "maxLabelImage": {
      "description": "Optional image for the maximum endpoint (blob reference).",
      "properties": {
        "mimeType": {
          "type": "string"
        },
        "ref": {
          "type": "cid-link"
        },
        "size": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "min": {
      "type": "integer"
    },
    "minLabel": {
      "description": "Optional label for the minimum value.",
      "maxLength": 128,
      "type": "string"
    },
    "minLabelImage": {
      "description": "Optional image for the minimum endpoint (blob reference).",
      "properties": {
        "mimeType": {
          "type": "string"
        },
        "ref": {
          "type": "cid-link"
        },
        "size": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "unit": {
      "maxLength": 64,
      "type": "string"
    },
    "unitsPerWhole": {
      "description": "Divide the stored integer by this to get the value in `unit`s. Any positive integer, not just a power of 10. Choose min/max directly in the smallest (or coarsest) legal increment — every integer between min and max is then a valid value, by construction.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "min",
    "max",
    "unitsPerWhole"
  ],
  "type": "object"
}
intervalValue object

No description available.

Properties

value integer Required

No description available.

View raw schema
{
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}
nominal object

No description available.

Properties

options array of ref#nominalOption Required

No description available.

View raw schema
{
  "properties": {
    "options": {
      "items": {
        "ref": "#nominalOption",
        "type": "ref"
      },
      "maxItems": 100,
      "type": "array"
    }
  },
  "required": [
    "options"
  ],
  "type": "object"
}
nominalOption object

No description available.

Properties

description string Optional

No description available.

maxLength: 256 bytes
label string Required

No description available.

maxLength: 128 bytes
labelImage object Optional

Optional image for this option (blob reference).

value string Required

No description available.

maxLength: 64 bytes
View raw schema
{
  "properties": {
    "description": {
      "maxLength": 256,
      "type": "string"
    },
    "label": {
      "maxLength": 128,
      "type": "string"
    },
    "labelImage": {
      "description": "Optional image for this option (blob reference).",
      "properties": {
        "mimeType": {
          "type": "string"
        },
        "ref": {
          "type": "cid-link"
        },
        "size": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "value": {
      "maxLength": 64,
      "type": "string"
    }
  },
  "required": [
    "label",
    "value"
  ],
  "type": "object"
}
nominalValue object

No description available.

Properties

value string Required

No description available.

maxLength: 64 bytes
View raw schema
{
  "properties": {
    "value": {
      "maxLength": 64,
      "type": "string"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}
ordinal object

No description available.

Properties

options array of ref#ordinalOption Required

No description available.

View raw schema
{
  "properties": {
    "options": {
      "items": {
        "ref": "#ordinalOption",
        "type": "ref"
      },
      "maxItems": 100,
      "type": "array"
    }
  },
  "required": [
    "options"
  ],
  "type": "object"
}
ordinalOption object

No description available.

Properties

description string Optional

No description available.

maxLength: 256 bytes
label string Required

No description available.

maxLength: 128 bytes
labelImage object Optional

Optional image for this option (blob reference).

value integer Required

Rank. Leave gaps for future insertions.

View raw schema
{
  "properties": {
    "description": {
      "maxLength": 256,
      "type": "string"
    },
    "label": {
      "maxLength": 128,
      "type": "string"
    },
    "labelImage": {
      "description": "Optional image for this option (blob reference).",
      "properties": {
        "mimeType": {
          "type": "string"
        },
        "ref": {
          "type": "cid-link"
        },
        "size": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "value": {
      "description": "Rank. Leave gaps for future insertions.",
      "type": "integer"
    }
  },
  "required": [
    "label",
    "value"
  ],
  "type": "object"
}
ordinalValue object

No description available.

Properties

value integer Required

No description available.

View raw schema
{
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}
ratio object

No description available.

Properties

max integer Required

No description available.

maxLabel string Optional

Optional label for the maximum value.

maxLength: 128 bytes
maxLabelImage object Optional

Optional image for the maximum endpoint (blob reference).

min integer Required

No description available.

minLabel string Optional

Optional label for the minimum value (true absence).

maxLength: 128 bytes
minLabelImage object Optional

Optional image for the minimum endpoint (blob reference).

unit string Optional

No description available.

maxLength: 64 bytes
unitsPerWhole integer Required

Divide the stored integer by this to get the value in `unit`s. Choose min/max directly in the smallest (or coarsest) legal increment so that every integer between min and max is then a valid value.

minimum: 1
View raw schema
{
  "properties": {
    "max": {
      "type": "integer"
    },
    "maxLabel": {
      "description": "Optional label for the maximum value.",
      "maxLength": 128,
      "type": "string"
    },
    "maxLabelImage": {
      "description": "Optional image for the maximum endpoint (blob reference).",
      "properties": {
        "mimeType": {
          "type": "string"
        },
        "ref": {
          "type": "cid-link"
        },
        "size": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "min": {
      "type": "integer"
    },
    "minLabel": {
      "description": "Optional label for the minimum value (true absence).",
      "maxLength": 128,
      "type": "string"
    },
    "minLabelImage": {
      "description": "Optional image for the minimum endpoint (blob reference).",
      "properties": {
        "mimeType": {
          "type": "string"
        },
        "ref": {
          "type": "cid-link"
        },
        "size": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "unit": {
      "maxLength": 64,
      "type": "string"
    },
    "unitsPerWhole": {
      "description": "Divide the stored integer by this to get the value in `unit`s. Choose min/max directly in the smallest (or coarsest) legal increment so that every integer between min and max is then a valid value.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "min",
    "max",
    "unitsPerWhole"
  ],
  "type": "object"
}
ratioValue object

No description available.

Properties

value integer Required

No description available.

View raw schema
{
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}

Lexicon Garden

@