site.standard.document¶

class atproto_client.models.site.standard.document.Contributor¶

Bases: ModelBase

Definition model for site.standard.document.

field did: str [Required]¶

Did.

Constraints:

func = Validated by: string_formats.validate_did() (only when strict_string_format=True)
json_schema_input_type = PydanticUndefined

field display_name: str | None = None¶

Display name.

Constraints:

max_length = 1000

field py_type: Literal['site.standard.document#contributor'] = 'site.standard.document#contributor'¶

field role: str | None = None¶

Role.

Constraints:

max_length = 1000

class atproto_client.models.site.standard.document.CreateRecordResponse¶

Bases: SugarResponseModelBase

Create record response for models.SiteStandardDocument.Record.

field cid: str [Required]¶: The CID of the record.

field uri: str [Required]¶: The URI of the record.

class atproto_client.models.site.standard.document.GetRecordResponse¶

Bases: SugarResponseModelBase

Get record response for models.SiteStandardDocument.Record.

field cid: str | None = None¶: The CID of the record.

field uri: str [Required]¶: The URI of the record.

field value: models.SiteStandardDocument.Record [Required]¶: The record.

class atproto_client.models.site.standard.document.ListRecordsResponse¶

Bases: SugarResponseModelBase

List records response for models.SiteStandardDocument.Record.

field cursor: str | None = None¶: Next page cursor.

field records: Dict[str, models.SiteStandardDocument.Record] [Required]¶: Map of URIs to records.

class atproto_client.models.site.standard.document.Record¶

Bases: RecordModelBase

Record model for site.standard.document.

field bsky_post_ref: models.ComAtprotoRepoStrongRef.Main | None = None¶

field content: base.UnknownUnionModel | None = None¶

field contributors: List[models.SiteStandardDocument.Contributor] | None = None¶: Contributors.

field cover_image: BlobRef | None = None¶: Image to used for thumbnail or cover image. Less than 1MB is size.

field description: str | None = None¶

Constraints:

max_length = 30000

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

field links: base.UnknownUnionModel | None = None¶

field path: str | None = None¶

field published_at: str [Required]¶

Timestamp of the documents publish time.

Constraints:

func = Validated by: string_formats.validate_datetime() (only when strict_string_format=True)
json_schema_input_type = PydanticUndefined

field py_type: Literal['site.standard.document'] = 'site.standard.document'¶

field site: str [Required]¶

Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes.

Constraints:

func = Validated by: string_formats.validate_uri() (only when strict_string_format=True)
json_schema_input_type = PydanticUndefined

field tags: List[str] | None = None¶

field text_content: str | None = None¶

field title: str [Required]¶

Title of the document.

Constraints:

max_length = 5000

field updated_at: str | None = None¶: Timestamp of the documents last edit.