app.bivri.support.contentDefs

lexicons.bivri.app

Documentation

announcementSummary object

No description available.

Properties

categoryId string Required

No description available.

categoryName string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
id string Required

No description available.

pinned boolean Required

No description available.

publishedAt string datetime Required

An RFC 3339 formatted timestamp.

title string Required

No description available.

maxLength: 2000 bytesmaxGraphemes: 200 graphemes
View raw schema 
{
  "properties": {
    "categoryId": {
      "type": "string"
    },
    "categoryName": {
      "maxGraphemes": 100,
      "maxLength": 1000,
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    },
    "publishedAt": {
      "format": "datetime",
      "type": "string"
    },
    "title": {
      "maxGraphemes": 200,
      "maxLength": 2000,
      "type": "string"
    }
  },
  "required": [
    "id",
    "categoryId",
    "categoryName",
    "title",
    "pinned",
    "publishedAt"
  ],
  "type": "object"
}
announcementView object

No description available.

Properties

categoryId string Required

No description available.

categoryName string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
content string Required

No description available.

maxLength: 1000000 bytesmaxGraphemes: 100000 graphemes
contentFormat string Required

No description available.

Known values: markdown
id string Required

No description available.

pinned boolean Required

No description available.

publishedAt string datetime Required

An RFC 3339 formatted timestamp.

title string Required

No description available.

maxLength: 2000 bytesmaxGraphemes: 200 graphemes
View raw schema 
{
  "nullable": [
    "newer",
    "older"
  ],
  "properties": {
    "categoryId": {
      "type": "string"
    },
    "categoryName": {
      "maxGraphemes": 100,
      "maxLength": 1000,
      "type": "string"
    },
    "content": {
      "maxGraphemes": 100000,
      "maxLength": 1000000,
      "type": "string"
    },
    "contentFormat": {
      "knownValues": [
        "markdown"
      ],
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "newer": {
      "ref": "app.bivri.support.contentDefs#announcementSummary",
      "type": "ref"
    },
    "older": {
      "ref": "app.bivri.support.contentDefs#announcementSummary",
      "type": "ref"
    },
    "pinned": {
      "type": "boolean"
    },
    "publishedAt": {
      "format": "datetime",
      "type": "string"
    },
    "title": {
      "maxGraphemes": 200,
      "maxLength": 2000,
      "type": "string"
    }
  },
  "required": [
    "id",
    "categoryId",
    "categoryName",
    "title",
    "pinned",
    "publishedAt",
    "contentFormat",
    "content",
    "newer",
    "older"
  ],
  "type": "object"
}
bannerImage object

No description available.

Properties

alt string Required

No description available.

src string uri Required

A valid URI.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "properties": {
    "alt": {
      "type": "string"
    },
    "src": {
      "format": "uri",
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "src",
    "alt"
  ],
  "type": "object"
}
bannerView object

A published announcement enabled for the home banner. Its destination is /notices/{id}. Image is omitted when its Artwork is no longer servable.

Properties

id string Required

No description available.

position integer Required

No description available.

minimum: 0maximum: 9007199254740991
summary string Required

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
title string Required

No description available.

maxLength: 2000 bytesmaxGraphemes: 200 graphemes
View raw schema 
{
  "description": "A published announcement enabled for the home banner. Its destination is /notices/{id}. Image is omitted when its Artwork is no longer servable.",
  "properties": {
    "id": {
      "type": "string"
    },
    "image": {
      "ref": "#bannerImage",
      "type": "ref"
    },
    "position": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "summary": {
      "maxGraphemes": 300,
      "maxLength": 3000,
      "type": "string"
    },
    "title": {
      "maxGraphemes": 200,
      "maxLength": 2000,
      "type": "string"
    }
  },
  "required": [
    "id",
    "title",
    "summary",
    "position"
  ],
  "type": "object"
}
categoryView object

No description available.

Properties

id string Required

No description available.

name string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
position integer Required

No description available.

minimum: 0
View raw schema 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "maxGraphemes": 100,
      "maxLength": 1000,
      "type": "string"
    },
    "position": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "position"
  ],
  "type": "object"
}
faqView object

No description available.

Properties

answer string Required

No description available.

maxLength: 1000000 bytesmaxGraphemes: 100000 graphemes
categoryId string Required

No description available.

categoryName string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
contentFormat string Required

No description available.

Known values: markdown
id string Required

No description available.

position integer Required

No description available.

minimum: 0
publishedAt string datetime Required

An RFC 3339 formatted timestamp.

question string Required

No description available.

maxLength: 5000 bytesmaxGraphemes: 500 graphemes
View raw schema 
{
  "properties": {
    "answer": {
      "maxGraphemes": 100000,
      "maxLength": 1000000,
      "type": "string"
    },
    "categoryId": {
      "type": "string"
    },
    "categoryName": {
      "maxGraphemes": 100,
      "maxLength": 1000,
      "type": "string"
    },
    "contentFormat": {
      "knownValues": [
        "markdown"
      ],
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "position": {
      "minimum": 0,
      "type": "integer"
    },
    "publishedAt": {
      "format": "datetime",
      "type": "string"
    },
    "question": {
      "maxGraphemes": 500,
      "maxLength": 5000,
      "type": "string"
    }
  },
  "required": [
    "id",
    "categoryId",
    "categoryName",
    "question",
    "contentFormat",
    "answer",
    "position",
    "publishedAt"
  ],
  "type": "object"
}

Lexicon Garden

@