Skip to main content

Interface: CreateStandardDocumentInput

Defined in: web/lib/atproto/record-creator.ts:2264

Input for creating a standard.site document.

Properties​

citations?​

optional citations: StandardCitationLink[]

Defined in: web/lib/atproto/record-creator.ts:2306

Typed citations to write into the document's links union.

Remarks​

Omitted, no links are written. See StandardCitationLink for why this is opt-in rather than automatic.

contributors?​

optional contributors: StandardDocumentContributor[]

Defined in: web/lib/atproto/record-creator.ts:2296

Authors, mapped to standard.site contributors

description?​

optional description: string

Defined in: web/lib/atproto/record-creator.ts:2268

Brief description or abstract

eprintCid?​

optional eprintCid: string

Defined in: web/lib/atproto/record-creator.ts:2272

CID of the eprint record

eprintUri​

eprintUri: string

Defined in: web/lib/atproto/record-creator.ts:2270

AT-URI of the eprint this document describes

publishedAt?​

optional publishedAt: string

Defined in: web/lib/atproto/record-creator.ts:2292

When the eprint was published; defaults to now

siteUrl?​

optional siteUrl: string

Defined in: web/lib/atproto/record-creator.ts:2290

Origin this deployment serves from, without a trailing slash.

Remarks​

Becomes the record's site.

The schema takes either a publication record's AT-URI or a bare url, and says the url form is "for loose documents". An eprint is not loose: it belongs to its author's body of work, and naming the publication is what lets a reader subscribe to that author from a link card. Callers should pass the publication's AT-URI and leave the url form to callers that have no publication to name.

Combined with path it is the canonical URL of the eprint, which is how a standard.site reader verifies that the document and the page describe the same thing.

tags?​

optional tags: string[]

Defined in: web/lib/atproto/record-creator.ts:2298

Keywords

textContent?​

optional textContent: string

Defined in: web/lib/atproto/record-creator.ts:2294

Plaintext abstract

title​

title: string

Defined in: web/lib/atproto/record-creator.ts:2266

Title of the document