site.standard.publication

A publication record representing a blog, website, or content platform. Publications serve as containers for documents and define the overall branding and settings.

class atproto_client.models.site.standard.publication.Preferences

Bases: ModelBase

Definition model for site.standard.publication.

field show_in_discover: bool | None = True

class atproto_client.models.site.standard.publication.Record

Bases: RecordModelBase

Record model for site.standard.publication.

field basic_theme: models.SiteStandardThemeBasic.Record | None = None

field description: str | None = None

Brief description of the publication.

Constraints:

• max_length = 30000

field icon: BlobRef | None = None

Square image to identify the publication. Should be at least 256x256.

field labels: models.ComAtprotoLabelDefs.SelfLabels | DotDict | None = None

field name: str [Required]

Name of the publication.

Constraints:

• max_length = 5000

field preferences: models.SiteStandardPublication.Preferences | None = None

field url: Uri [Required]

Base publication url (ex: https://standard.site). The canonical document URL is formed by combining this value with the document path.

class atproto_client.models.site.standard.publication.GetRecordResponse

Bases: SugarResponseModelBase

Get record response for models.SiteStandardPublication.Record.

field cid: str | None = None

The CID of the record.

field uri: str [Required]

The URI of the record.

field value: models.SiteStandardPublication.Record [Required]

The record.

class atproto_client.models.site.standard.publication.ListRecordsResponse

Bases: SugarResponseModelBase

List records response for models.SiteStandardPublication.Record.

field cursor: str | None = None

Next page cursor.

field records: Dict[str, models.SiteStandardPublication.Record] [Required]

Map of URIs to records.

class atproto_client.models.site.standard.publication.CreateRecordResponse

Bases: SugarResponseModelBase

Create record response for models.SiteStandardPublication.Record.

field cid: str [Required]

The CID of the record.

field uri: str [Required]

The URI of the record.