com.atproto.label.query_labels

pydantic model atproto.xrpc_client.models.com.atproto.label.query_labels.Params

Bases: ParamsModelBase

Parameters model for com.atproto.label.queryLabels.

Show JSON schema

{
   "title": "Params",
   "description": "Parameters model for :obj:`com.atproto.label.queryLabels`.",
   "type": "object",
   "properties": {
      "uriPatterns": {
         "items": {
            "type": "string"
         },
         "title": "Uripatterns",
         "type": "array"
      },
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 250,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 50,
         "title": "Limit"
      },
      "sources": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Sources"
      }
   },
   "additionalProperties": false,
   "required": [
      "uriPatterns"
   ]
}

Fields:

• cursor (Optional[str])

• limit (Optional[int])

• sources (Optional[List[str]])

• uri_patterns (List[str])

field cursor: Optional[str] = None

Cursor.

field limit: Optional[int] = 50

Limit.

Constraints:

• ge = 1

• le = 250

field sources: Optional[List[str]] = None

Optional list of label sources (DIDs) to filter on.

field uri_patterns: List[str] [Required] (alias 'uriPatterns')

List of AT URI patterns to match (boolean ‘OR’). Each may be a prefix (ending with ‘*’; will match inclusive of the string leading to ‘*’), or a full URI.

class atproto.xrpc_client.models.com.atproto.label.query_labels.ParamsDict

Bases: TypedDict

cursor: typing_extensions.NotRequired[Optional[str]]

Cursor.

limit: typing_extensions.NotRequired[Optional[int]]

Limit.

sources: typing_extensions.NotRequired[Optional[List[str]]]

Optional list of label sources (DIDs) to filter on.

uri_patterns: List[str]

List of AT URI patterns to match (boolean ‘OR’). Each may be a prefix (ending with ‘*’; will match inclusive of the string leading to ‘*’), or a full URI.

pydantic model atproto.xrpc_client.models.com.atproto.label.query_labels.Response

Bases: ResponseModelBase

Output data model for com.atproto.label.queryLabels.

Show JSON schema

{
   "title": "Response",
   "description": "Output data model for :obj:`com.atproto.label.queryLabels`.",
   "type": "object",
   "properties": {
      "labels": {
         "items": {
            "$ref": "#/$defs/Label"
         },
         "title": "Labels",
         "type": "array"
      },
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      }
   },
   "$defs": {
      "Label": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.label.defs`. Metadata tag on an atproto resource (eg, repo or record)",
         "properties": {
            "cts": {
               "title": "Cts",
               "type": "string"
            },
            "src": {
               "title": "Src",
               "type": "string"
            },
            "uri": {
               "title": "Uri",
               "type": "string"
            },
            "val": {
               "maxLength": 128,
               "title": "Val",
               "type": "string"
            },
            "cid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cid"
            },
            "neg": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Neg"
            },
            "$type": {
               "const": "com.atproto.label.defs#label",
               "default": "com.atproto.label.defs#label",
               "title": "$Type"
            }
         },
         "required": [
            "cts",
            "src",
            "uri",
            "val"
         ],
         "title": "Label",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "labels"
   ]
}

Fields:

• cursor (Optional[str])

• labels (List[models.ComAtprotoLabelDefs.Label])

field cursor: Optional[str] = None

Cursor.

field labels: List[models.ComAtprotoLabelDefs.Label] [Required]

Labels.