app.bsky.graph.list

pydantic model atproto.xrpc_client.models.app.bsky.graph.list.Main

Bases: RecordModelBase

Record model for app.bsky.graph.list.

Show JSON schema

{
   "title": "Main",
   "description": "Record model for :obj:`app.bsky.graph.list`.",
   "type": "object",
   "properties": {
      "createdAt": {
         "title": "Createdat",
         "type": "string"
      },
      "name": {
         "maxLength": 64,
         "minLength": 1,
         "title": "Name",
         "type": "string"
      },
      "purpose": {
         "anyOf": [
            {
               "const": "app.bsky.graph.defs#modlist"
            },
            {
               "const": "app.bsky.graph.defs#curatelist"
            }
         ],
         "title": "Purpose"
      },
      "avatar": {
         "anyOf": [
            {
               "$ref": "#/$defs/BlobRef"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "description": {
         "anyOf": [
            {
               "maxLength": 3000,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "descriptionFacets": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Main"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Descriptionfacets"
      },
      "labels": {
         "anyOf": [
            {
               "default": null,
               "discriminator": {
                  "mapping": {
                     "com.atproto.label.defs#selfLabels": "#/$defs/SelfLabels"
                  },
                  "propertyName": "$type"
               },
               "oneOf": [
                  {
                     "$ref": "#/$defs/SelfLabels"
                  }
               ]
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Labels"
      },
      "$type": {
         "const": "app.bsky.graph.list",
         "default": "app.bsky.graph.list",
         "title": "$Type"
      }
   },
   "$defs": {
      "BlobRef": {
         "additionalProperties": false,
         "description": "Blob reference.",
         "properties": {
            "mimeType": {
               "title": "Mimetype",
               "type": "string"
            },
            "size": {
               "title": "Size",
               "type": "integer"
            },
            "ref": {
               "$ref": "#/$defs/BlobRefLink"
            },
            "$type": {
               "const": "blob",
               "default": "blob",
               "title": "$Type"
            }
         },
         "required": [
            "mimeType",
            "size",
            "ref"
         ],
         "title": "BlobRef",
         "type": "object"
      },
      "BlobRefLink": {
         "description": "Blob reference link.",
         "properties": {
            "$link": {
               "title": "$Link",
               "type": "string"
            }
         },
         "required": [
            "$link"
         ],
         "title": "BlobRefLink",
         "type": "object"
      },
      "ByteSlice": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.richtext.facet`. A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.",
         "properties": {
            "byteEnd": {
               "minimum": 0,
               "title": "Byteend",
               "type": "integer"
            },
            "byteStart": {
               "minimum": 0,
               "title": "Bytestart",
               "type": "integer"
            },
            "$type": {
               "const": "app.bsky.richtext.facet#byteSlice",
               "default": "app.bsky.richtext.facet#byteSlice",
               "title": "$Type"
            }
         },
         "required": [
            "byteEnd",
            "byteStart"
         ],
         "title": "ByteSlice",
         "type": "object"
      },
      "Link": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.richtext.facet`. A facet feature for links.",
         "properties": {
            "uri": {
               "title": "Uri",
               "type": "string"
            },
            "$type": {
               "const": "app.bsky.richtext.facet#link",
               "default": "app.bsky.richtext.facet#link",
               "title": "$Type"
            }
         },
         "required": [
            "uri"
         ],
         "title": "Link",
         "type": "object"
      },
      "Main": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.richtext.facet`.",
         "properties": {
            "features": {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "app.bsky.richtext.facet#link": "#/$defs/Link",
                        "app.bsky.richtext.facet#mention": "#/$defs/Mention",
                        "app.bsky.richtext.facet#tag": "#/$defs/Tag"
                     },
                     "propertyName": "$type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/Mention"
                     },
                     {
                        "$ref": "#/$defs/Link"
                     },
                     {
                        "$ref": "#/$defs/Tag"
                     }
                  ]
               },
               "title": "Features",
               "type": "array"
            },
            "index": {
               "$ref": "#/$defs/ByteSlice"
            },
            "$type": {
               "const": "app.bsky.richtext.facet",
               "default": "app.bsky.richtext.facet",
               "title": "$Type"
            }
         },
         "required": [
            "features",
            "index"
         ],
         "title": "Main",
         "type": "object"
      },
      "Mention": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.richtext.facet`. A facet feature for actor mentions.",
         "properties": {
            "did": {
               "title": "Did",
               "type": "string"
            },
            "$type": {
               "const": "app.bsky.richtext.facet#mention",
               "default": "app.bsky.richtext.facet#mention",
               "title": "$Type"
            }
         },
         "required": [
            "did"
         ],
         "title": "Mention",
         "type": "object"
      },
      "SelfLabel": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.label.defs`. Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel.",
         "properties": {
            "val": {
               "maxLength": 128,
               "title": "Val",
               "type": "string"
            },
            "$type": {
               "const": "com.atproto.label.defs#selfLabel",
               "default": "com.atproto.label.defs#selfLabel",
               "title": "$Type"
            }
         },
         "required": [
            "val"
         ],
         "title": "SelfLabel",
         "type": "object"
      },
      "SelfLabels": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.label.defs`. Metadata tags on an atproto record, published by the author within the record.",
         "properties": {
            "values": {
               "items": {
                  "$ref": "#/$defs/SelfLabel"
               },
               "maxItems": 10,
               "title": "Values",
               "type": "array"
            },
            "$type": {
               "const": "com.atproto.label.defs#selfLabels",
               "default": "com.atproto.label.defs#selfLabels",
               "title": "$Type"
            }
         },
         "required": [
            "values"
         ],
         "title": "SelfLabels",
         "type": "object"
      },
      "Tag": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.richtext.facet`. A hashtag.",
         "properties": {
            "tag": {
               "maxLength": 640,
               "title": "Tag",
               "type": "string"
            },
            "$type": {
               "const": "app.bsky.richtext.facet#tag",
               "default": "app.bsky.richtext.facet#tag",
               "title": "$Type"
            }
         },
         "required": [
            "tag"
         ],
         "title": "Tag",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "createdAt",
      "name",
      "purpose"
   ]
}

Fields:

• avatar (Optional[BlobRef])

• created_at (str)

• description (Optional[str])

• description_facets (Optional[List[models.AppBskyRichtextFacet.Main]])

• labels (Optional[models.ComAtprotoLabelDefs.SelfLabels[models.ComAtprotoLabelDefs.SelfLabels]])

• name (str)

• purpose (models.AppBskyGraphDefs.ListPurpose)

• py_type (typing_extensions.Literal[app.bsky.graph.list])

field avatar: Optional[BlobRef] = None

Avatar.

field created_at: str [Required] (alias 'createdAt')

Created at.

field description: Optional[str] = None

Description.

Constraints:

• max_length = 3000

field description_facets: Optional[List[models.AppBskyRichtextFacet.Main]] = None (alias 'descriptionFacets')

Description facets.

field labels: Optional[SelfLabels[models.ComAtprotoLabelDefs.SelfLabels]] = None

field name: str [Required]

Name.

Constraints:

• min_length = 1

• max_length = 64

field purpose: models.AppBskyGraphDefs.ListPurpose [Required]

Purpose.

field py_type: typing_extensions.Literal[app.bsky.graph.list] = 'app.bsky.graph.list' (alias '$type')