net.atpix.gallery.defs

lexicon.atpix.net

Documentation

album object

No description available.

Properties

collectionRuleUris array of stringat-uri Optional

No description available.

coverPhotoUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdAt string datetime Required

An RFC 3339 formatted timestamp.

creator string did Optional

A decentralized identifier (DID).

description string Optional

No description available.

maxLength: 5000 bytes

modifiedAt string datetime Optional

An RFC 3339 formatted timestamp.

name string Required

No description available.

maxLength: 200 bytes

spaceUri string Optional

No description available.

maxLength: 512 bytes

visibility ref #visibility Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "createdAt",
    "visibility"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200
    },
    "creator": {
      "type": "string",
      "format": "did"
    },
    "spaceUri": {
      "type": "string",
      "maxLength": 512
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "modifiedAt": {
      "type": "string",
      "format": "datetime"
    },
    "visibility": {
      "ref": "#visibility",
      "type": "ref"
    },
    "description": {
      "type": "string",
      "maxLength": 5000
    },
    "coverPhotoUri": {
      "type": "string",
      "format": "at-uri"
    },
    "collectionRuleUris": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    }
  }
}

albumView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

record ref #album Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "record"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "record": {
      "ref": "#album",
      "type": "ref"
    }
  }
}

geoPlace object

Subset of schema:Place for schema:locationCreated.

Properties

latitude string Optional

schema:GeoCoordinates.latitude (WGS 84), decimal degrees as a string (atproto has no float type).

longitude string Optional

schema:GeoCoordinates.longitude (WGS 84), decimal degrees as a string (atproto has no float type).

name string Optional

schema:Place.name — human-readable place name.

maxLength: 500 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 500,
      "description": "schema:Place.name — human-readable place name."
    },
    "latitude": {
      "type": "string",
      "description": "schema:GeoCoordinates.latitude (WGS 84), decimal degrees as a string (atproto has no float type)."
    },
    "longitude": {
      "type": "string",
      "description": "schema:GeoCoordinates.longitude (WGS 84), decimal degrees as a string (atproto has no float type)."
    }
  },
  "description": "Subset of schema:Place for schema:locationCreated."
}

photo object

Hydrated photo record view (subset of net.atpix.gallery.photo fields).

Properties

albumUris array of stringat-uri Optional

No description available.

caption string Optional

No description available.

maxLength: 2000 bytes

contributor string did Optional

A decentralized identifier (DID).

copyrightHolder string did Optional

A decentralized identifier (DID).

createdAt string datetime Required

An RFC 3339 formatted timestamp.

creator string did Optional

A decentralized identifier (DID).

description string Optional

No description available.

maxLength: 5000 bytes

height integer Optional

No description available.

minimum: 1

image blob Required

No description available.

inLanguage string Optional

No description available.

maxLength: 35 bytes

keywords array of string Optional

No description available.

license string uri Optional

A valid URI.

locationCreated ref #geoPlace Optional

No description available.

modifiedAt string datetime Optional

An RFC 3339 formatted timestamp.

source string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

spaceUri string Optional

No description available.

maxLength: 512 bytes

thumbnail blob Optional

No description available.

title string Optional

No description available.

maxLength: 500 bytes

visibility ref #visibility Optional

No description available.

width integer Optional

No description available.

minimum: 1

View raw schema

{
  "type": "object",
  "required": [
    "image",
    "createdAt"
  ],
  "properties": {
    "image": {
      "type": "blob",
      "accept": [
        "image/*"
      ]
    },
    "title": {
      "type": "string",
      "maxLength": 500
    },
    "width": {
      "type": "integer",
      "minimum": 1
    },
    "height": {
      "type": "integer",
      "minimum": 1
    },
    "source": {
      "type": "string",
      "format": "at-uri"
    },
    "caption": {
      "type": "string",
      "maxLength": 2000
    },
    "creator": {
      "type": "string",
      "format": "did"
    },
    "license": {
      "type": "string",
      "format": "uri"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      }
    },
    "spaceUri": {
      "type": "string",
      "maxLength": 512
    },
    "albumUris": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "thumbnail": {
      "type": "blob",
      "accept": [
        "image/*"
      ]
    },
    "inLanguage": {
      "type": "string",
      "maxLength": 35
    },
    "modifiedAt": {
      "type": "string",
      "format": "datetime"
    },
    "visibility": {
      "ref": "#visibility",
      "type": "ref"
    },
    "contributor": {
      "type": "string",
      "format": "did"
    },
    "description": {
      "type": "string",
      "maxLength": 5000
    },
    "copyrightHolder": {
      "type": "string",
      "format": "did"
    },
    "locationCreated": {
      "ref": "#geoPlace",
      "type": "ref"
    }
  },
  "description": "Hydrated photo record view (subset of net.atpix.gallery.photo fields)."
}

photoView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

record ref #photo Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "record"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "record": {
      "ref": "#photo",
      "type": "ref"
    }
  }
}

targetScope string

Whether a collection rule powers the social gallery feed or a specific album.

Allowed Values (closed enum)

gallery album

View raw schema

{
  "enum": [
    "gallery",
    "album"
  ],
  "type": "string",
  "description": "Whether a collection rule powers the social gallery feed or a specific album."
}

visibility string

ATPix visibility scope. Permissioned uses HappyView Permissioned Spaces (ATP-0016).

Allowed Values (closed enum)

public unlisted permissioned

View raw schema

{
  "enum": [
    "public",
    "unlisted",
    "permissioned"
  ],
  "type": "string",
  "description": "ATPix visibility scope. Permissioned uses HappyView Permissioned Spaces (ATP-0016)."
}