pub.chive.collection.defs

chive.pub

Documentation

collectionItemRef object

Reference to a collection item that triggered a feed event

Properties

label string Required

Display label of the collection item

uri string Required

AT-URI of the collection item

View raw schema

{
  "type": "object",
  "required": [
    "label",
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "description": "AT-URI of the collection item"
    },
    "label": {
      "type": "string",
      "description": "Display label of the collection item"
    }
  },
  "description": "Reference to a collection item that triggered a feed event"
}

collectionItemView object

View of an item in a collection

Properties

addedAt string datetime Required

When the item was added to the collection

authors array of string Optional

Resolved author names for eprint items

avatar string Optional

Avatar URL for person or institution nodes

description string Optional

Description for graph node items

edgeUri string at-uri Required

AT-URI of the CONTAINS edge record

itemType string Required

Inferred type of the item

Known values: eprint, author, graphNode, review, endorsement, external

itemUri string Required

AT-URI or identifier of the contained item

kind string Optional

Node kind for graph node items

label string Optional

Resolved label for graph node items

metadata unknown Optional

Additional item metadata from the personal graph node

note string Optional

Optional user annotation on the item

order integer Required

Display order within the collection

source string Optional

Whether the item node is personal or cloned from community

Known values: personal, community

subkind string Optional

Node subkind for graph node items

title string Optional

Resolved title for eprint items

View raw schema

{
  "type": "object",
  "required": [
    "edgeUri",
    "itemUri",
    "itemType",
    "order",
    "addedAt"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "description": "Node kind for graph node items"
    },
    "note": {
      "type": "string",
      "description": "Optional user annotation on the item"
    },
    "label": {
      "type": "string",
      "description": "Resolved label for graph node items"
    },
    "order": {
      "type": "integer",
      "description": "Display order within the collection"
    },
    "title": {
      "type": "string",
      "description": "Resolved title for eprint items"
    },
    "avatar": {
      "type": "string",
      "description": "Avatar URL for person or institution nodes"
    },
    "source": {
      "type": "string",
      "description": "Whether the item node is personal or cloned from community",
      "knownValues": [
        "personal",
        "community"
      ]
    },
    "addedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the item was added to the collection"
    },
    "authors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Resolved author names for eprint items"
    },
    "edgeUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the CONTAINS edge record"
    },
    "itemUri": {
      "type": "string",
      "description": "AT-URI or identifier of the contained item"
    },
    "subkind": {
      "type": "string",
      "description": "Node subkind for graph node items"
    },
    "itemType": {
      "type": "string",
      "description": "Inferred type of the item",
      "knownValues": [
        "eprint",
        "author",
        "graphNode",
        "review",
        "endorsement",
        "external"
      ]
    },
    "metadata": {
      "type": "unknown",
      "description": "Additional item metadata from the personal graph node"
    },
    "description": {
      "type": "string",
      "description": "Description for graph node items"
    }
  },
  "description": "View of an item in a collection"
}

collectionView object

View of a user collection

Properties

cid string Required

Content identifier

cosmikCollectionCid string Optional

CID of the mirrored Cosmik collection record

cosmikCollectionUri string Optional

AT-URI of the mirrored Cosmik collection, if Semble dual-write is enabled

cosmikItems unknown Optional

Mapping of item URLs to Cosmik card/link record URIs and CIDs

createdAt string datetime Required

Creation timestamp

description string Optional

Optional description of the collection

itemCount integer Required

Number of items in the collection

label string Required

Display label for the collection

ownerDid string did Required

DID of the collection owner

ownerHandle string Optional

Resolved handle of the collection owner

updatedAt string datetime Optional

Last update timestamp

uri string at-uri Required

AT-URI of the collection record

visibility string Required

Controls whether Chive's AppView surfaces this collection in listings and search

Known values: listed, unlisted

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "ownerDid",
    "label",
    "visibility",
    "itemCount",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "description": "Content identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the collection record"
    },
    "label": {
      "type": "string",
      "description": "Display label for the collection"
    },
    "ownerDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the collection owner"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation timestamp"
    },
    "itemCount": {
      "type": "integer",
      "description": "Number of items in the collection"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Last update timestamp"
    },
    "visibility": {
      "type": "string",
      "description": "Controls whether Chive's AppView surfaces this collection in listings and search",
      "knownValues": [
        "listed",
        "unlisted"
      ]
    },
    "cosmikItems": {
      "type": "unknown",
      "description": "Mapping of item URLs to Cosmik card/link record URIs and CIDs"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the collection"
    },
    "ownerHandle": {
      "type": "string",
      "description": "Resolved handle of the collection owner"
    },
    "cosmikCollectionCid": {
      "type": "string",
      "description": "CID of the mirrored Cosmik collection record"
    },
    "cosmikCollectionUri": {
      "type": "string",
      "description": "AT-URI of the mirrored Cosmik collection, if Semble dual-write is enabled"
    }
  },
  "description": "View of a user collection"
}

feedEventPayload object

Event-type-specific payload with details like titles, snippets, and DIDs

Properties

annotatorDid string did Optional

DID of the annotator

authorNames array of string Optional

Names of the eprint authors

contributions array of string Optional

Endorsement contribution types

endorserDid string did Optional

DID of the endorser

entityLabel string Optional

Label of the entity link

eprintTitle string Optional

Title of the relevant eprint

eprintUri string Optional

AT-URI of the relevant eprint

eventLabel string Optional

Label of the related event

fieldLabel string Optional

Label of the related field

institutionLabel string Optional

Label of the related institution

personLabel string Optional

Label of the related person

reviewerDid string did Optional

DID of the reviewer

snippet string Optional

Text snippet from the review or annotation

View raw schema

{
  "type": "object",
  "properties": {
    "snippet": {
      "type": "string",
      "description": "Text snippet from the review or annotation"
    },
    "eprintUri": {
      "type": "string",
      "description": "AT-URI of the relevant eprint"
    },
    "eventLabel": {
      "type": "string",
      "description": "Label of the related event"
    },
    "fieldLabel": {
      "type": "string",
      "description": "Label of the related field"
    },
    "authorNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names of the eprint authors"
    },
    "endorserDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the endorser"
    },
    "entityLabel": {
      "type": "string",
      "description": "Label of the entity link"
    },
    "eprintTitle": {
      "type": "string",
      "description": "Title of the relevant eprint"
    },
    "personLabel": {
      "type": "string",
      "description": "Label of the related person"
    },
    "reviewerDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the reviewer"
    },
    "annotatorDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the annotator"
    },
    "contributions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Endorsement contribution types"
    },
    "institutionLabel": {
      "type": "string",
      "description": "Label of the related institution"
    }
  },
  "description": "Event-type-specific payload with details like titles, snippets, and DIDs"
}

feedEventView object

A single event in a collection's activity feed

Properties

collectionItemSubkind string Required

Subkind of the collection item (person, eprint, field, institution, event)

collectionItemUri string Required

AT-URI of the collection item that this event relates to

collectionItems array of ref#collectionItemRef Optional

Collection items that triggered this event with label and URI

eventAt string datetime Required

When the event occurred

eventUri string Required

AT-URI of the entity that triggered this event

payload ref #feedEventPayload Required

Event-type-specific payload with details like titles, snippets, and DIDs

type string Required

Event type discriminant

Known values: eprint_by_author, review_on_eprint, endorsement_on_eprint, annotation_on_eprint, review_by_author, endorsement_by_author, eprint_in_field, eprint_by_institution, eprint_at_event, eprint_referencing_person

View raw schema

{
  "type": "object",
  "required": [
    "type",
    "eventUri",
    "eventAt",
    "collectionItemUri",
    "collectionItemSubkind",
    "payload"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Event type discriminant",
      "knownValues": [
        "eprint_by_author",
        "review_on_eprint",
        "endorsement_on_eprint",
        "annotation_on_eprint",
        "review_by_author",
        "endorsement_by_author",
        "eprint_in_field",
        "eprint_by_institution",
        "eprint_at_event",
        "eprint_referencing_person"
      ]
    },
    "eventAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the event occurred"
    },
    "payload": {
      "ref": "#feedEventPayload",
      "type": "ref",
      "description": "Event-type-specific payload with details like titles, snippets, and DIDs"
    },
    "eventUri": {
      "type": "string",
      "description": "AT-URI of the entity that triggered this event"
    },
    "collectionItems": {
      "type": "array",
      "items": {
        "ref": "#collectionItemRef",
        "type": "ref"
      },
      "description": "Collection items that triggered this event with label and URI"
    },
    "collectionItemUri": {
      "type": "string",
      "description": "AT-URI of the collection item that this event relates to"
    },
    "collectionItemSubkind": {
      "type": "string",
      "description": "Subkind of the collection item (person, eprint, field, institution, event)"
    }
  },
  "description": "A single event in a collection's activity feed"
}

interItemEdgeView object

An edge between two items within a collection

Properties

edgeUri string at-uri Optional

AT-URI of the personal graph edge record

relationSlug string Required

Relation type slug

sourceUri string Required

AT-URI of the source item

targetUri string Required

AT-URI of the target item

View raw schema

{
  "type": "object",
  "required": [
    "sourceUri",
    "targetUri",
    "relationSlug"
  ],
  "properties": {
    "edgeUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the personal graph edge record"
    },
    "sourceUri": {
      "type": "string",
      "description": "AT-URI of the source item"
    },
    "targetUri": {
      "type": "string",
      "description": "AT-URI of the target item"
    },
    "relationSlug": {
      "type": "string",
      "description": "Relation type slug"
    }
  },
  "description": "An edge between two items within a collection"
}