dev.frogspace.stacks.query

spacefrog.dev

Documentation

a named saved query: a structured filter over the owner's saved citations, evaluated client-side. no free-text grammar.

main record

a named saved query: a structured filter over the owner's saved citations, evaluated client-side. no free-text grammar.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

time the query was saved. preserve it when editing.

filter ref #filter Required

closed filter object. all fields are optional; an empty filter matches every saved citation. clients reject unknown keys.

name string Required

human-readable query name, at most 128 graphemes.

maxLength: 512 bytesmaxGraphemes: 128 graphemes
View raw schema 
{
  "description": "a named saved query: a structured filter over the owner's saved citations, evaluated client-side. no free-text grammar.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "time the query was saved. preserve it when editing.",
        "format": "datetime",
        "type": "string"
      },
      "filter": {
        "description": "closed filter object. all fields are optional; an empty filter matches every saved citation. clients reject unknown keys.",
        "ref": "#filter",
        "type": "ref"
      },
      "name": {
        "description": "human-readable query name, at most 128 graphemes.",
        "maxGraphemes": 128,
        "maxLength": 512,
        "type": "string"
      }
    },
    "required": [
      "name",
      "filter",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
filter object

structured filter over saved citations. all fields are optional; an empty filter matches everything.

Properties

addedAfter string datetime Optional

the item must have been saved at or after this time.

addedBefore string datetime Optional

the item must have been saved at or before this time.

collection string at-uri Optional

the item must belong to this collection record AT-URI.

ratingMax integer Optional

the item rating must be at most this value.

minimum: 1maximum: 5
ratingMin integer Optional

the item rating must be at least this value.

minimum: 1maximum: 5
readState string Optional

the item read state must equal this value.

Known values: unread, reading, read
subjectType string nsid Optional

the subject's collection NSID must equal this value (e.g. app.bsky.feed.post).

tagsAll array of string Optional

the item must carry every one of these tags.

maxLength: 32 items
tagsAny array of string Optional

the item must carry at least one of these tags.

maxLength: 32 items
View raw schema 
{
  "description": "structured filter over saved citations. all fields are optional; an empty filter matches everything.",
  "properties": {
    "addedAfter": {
      "description": "the item must have been saved at or after this time.",
      "format": "datetime",
      "type": "string"
    },
    "addedBefore": {
      "description": "the item must have been saved at or before this time.",
      "format": "datetime",
      "type": "string"
    },
    "collection": {
      "description": "the item must belong to this collection record AT-URI.",
      "format": "at-uri",
      "type": "string"
    },
    "ratingMax": {
      "description": "the item rating must be at most this value.",
      "maximum": 5,
      "minimum": 1,
      "type": "integer"
    },
    "ratingMin": {
      "description": "the item rating must be at least this value.",
      "maximum": 5,
      "minimum": 1,
      "type": "integer"
    },
    "readState": {
      "description": "the item read state must equal this value.",
      "knownValues": [
        "unread",
        "reading",
        "read"
      ],
      "type": "string"
    },
    "subjectType": {
      "description": "the subject's collection NSID must equal this value (e.g. app.bsky.feed.post).",
      "format": "nsid",
      "type": "string"
    },
    "tagsAll": {
      "description": "the item must carry every one of these tags.",
      "items": {
        "maxGraphemes": 64,
        "maxLength": 256,
        "type": "string"
      },
      "maxLength": 32,
      "type": "array"
    },
    "tagsAny": {
      "description": "the item must carry at least one of these tags.",
      "items": {
        "maxGraphemes": 64,
        "maxLength": 256,
        "type": "string"
      },
      "maxLength": 32,
      "type": "array"
    }
  },
  "type": "object"
}

Lexicon Garden

@