app.rocksky.event.defs

rocksky.app

Documentation

artistView object

An artist on an event lineup, linked to the Rocksky artist when one was resolved.

Properties

id string Optional

The unique identifier of the linked Rocksky artist.

mbid string Optional

MusicBrainz artist id.

name string Required

The artist name as billed on the event.

picture string Optional

The picture of the linked artist.

role string Optional

The artist's billing on this event.

Known values: headliner, support, opener, dj, special-guest, performer
sha256 string Optional

The SHA256 hash of the linked artist.

stage string Optional

The stage the artist plays on.

startsAt string datetime Optional

When this artist's set starts.

uri string at-uri Optional

AT-URI of the linked artist.

View raw schema
{
  "description": "An artist on an event lineup, linked to the Rocksky artist when one was resolved.",
  "properties": {
    "id": {
      "description": "The unique identifier of the linked Rocksky artist.",
      "type": "string"
    },
    "mbid": {
      "description": "MusicBrainz artist id.",
      "type": "string"
    },
    "name": {
      "description": "The artist name as billed on the event.",
      "type": "string"
    },
    "picture": {
      "description": "The picture of the linked artist.",
      "type": "string"
    },
    "role": {
      "description": "The artist's billing on this event.",
      "knownValues": [
        "headliner",
        "support",
        "opener",
        "dj",
        "special-guest",
        "performer"
      ],
      "type": "string"
    },
    "sha256": {
      "description": "The SHA256 hash of the linked artist.",
      "type": "string"
    },
    "stage": {
      "description": "The stage the artist plays on.",
      "type": "string"
    },
    "startsAt": {
      "description": "When this artist's set starts.",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "description": "AT-URI of the linked artist.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
eventView object

A music event: the calendar event merged with its app.rocksky.event.music annotation.

Properties

cid string cid Optional

CID of the calendar event record revision that was indexed.

createdAt string datetime Required

When the event record was created.

description string Optional

The description of the event.

endsAt string datetime Optional

When the event ends.

genre string Optional

The main genre of the event.

id string Required

The unique identifier of the event.

imageUrl string uri Optional

Poster or banner image of the event.

kind string Optional

What sort of music event this is (concert, festival...).

Known values: concert, festival, club-night, dj-set, livestream, release-party, listening-party
mode string Optional

The attendance mode, as a community.lexicon.calendar.event#mode token.

Known values: community.lexicon.calendar.event#inperson, community.lexicon.calendar.event#virtual, community.lexicon.calendar.event#hybrid
musicCid string cid Optional

CID of the music record revision that was indexed.

musicUri string at-uri Required

AT-URI of the app.rocksky.event.music record.

name string Required

The name of the event.

organizerAvatarUrl string uri Optional

The avatar of the publisher.

organizerDid string did Required

The DID of the repo that published the event.

organizerHandle string Optional

The handle of the publisher.

organizerName string Optional

The display name of the publisher.

startsAt string datetime Optional

When the event starts.

status string Optional

The event status, as a community.lexicon.calendar.event#status token.

Known values: community.lexicon.calendar.event#planned, community.lexicon.calendar.event#scheduled, community.lexicon.calendar.event#rescheduled, community.lexicon.calendar.event#cancelled, community.lexicon.calendar.event#postponed
tags array of string Optional

No description available.

ticketsUrl string uri Optional

Where tickets can be bought.

updatedAt string datetime Required

When the event was last indexed.

uri string at-uri Required

AT-URI of the community.lexicon.calendar.event record.

viewerRsvp string Optional

The authenticated viewer's RSVP, as a community.lexicon.calendar.rsvp status token. Absent when not authenticated or when the viewer has not responded.

Known values: community.lexicon.calendar.rsvp#going, community.lexicon.calendar.rsvp#interested, community.lexicon.calendar.rsvp#notgoing
View raw schema
{
  "description": "A music event: the calendar event merged with its app.rocksky.event.music annotation.",
  "properties": {
    "artists": {
      "description": "The lineup, in billing order.",
      "items": {
        "ref": "app.rocksky.event.defs#artistView",
        "type": "ref"
      },
      "type": "array"
    },
    "cid": {
      "description": "CID of the calendar event record revision that was indexed.",
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "description": "When the event record was created.",
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "description": "The description of the event.",
      "type": "string"
    },
    "endsAt": {
      "description": "When the event ends.",
      "format": "datetime",
      "type": "string"
    },
    "externalIds": {
      "ref": "app.rocksky.event.music#externalIds",
      "type": "ref"
    },
    "genre": {
      "description": "The main genre of the event.",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the event.",
      "type": "string"
    },
    "imageUrl": {
      "description": "Poster or banner image of the event.",
      "format": "uri",
      "type": "string"
    },
    "kind": {
      "description": "What sort of music event this is (concert, festival...).",
      "knownValues": [
        "concert",
        "festival",
        "club-night",
        "dj-set",
        "livestream",
        "release-party",
        "listening-party"
      ],
      "type": "string"
    },
    "locations": {
      "description": "Where the event takes place.",
      "items": {
        "ref": "app.rocksky.event.defs#locationView",
        "type": "ref"
      },
      "type": "array"
    },
    "mode": {
      "description": "The attendance mode, as a community.lexicon.calendar.event#mode token.",
      "knownValues": [
        "community.lexicon.calendar.event#inperson",
        "community.lexicon.calendar.event#virtual",
        "community.lexicon.calendar.event#hybrid"
      ],
      "type": "string"
    },
    "musicCid": {
      "description": "CID of the music record revision that was indexed.",
      "format": "cid",
      "type": "string"
    },
    "musicUri": {
      "description": "AT-URI of the app.rocksky.event.music record.",
      "format": "at-uri",
      "type": "string"
    },
    "name": {
      "description": "The name of the event.",
      "type": "string"
    },
    "organizerAvatarUrl": {
      "description": "The avatar of the publisher.",
      "format": "uri",
      "type": "string"
    },
    "organizerDid": {
      "description": "The DID of the repo that published the event.",
      "format": "did",
      "type": "string"
    },
    "organizerHandle": {
      "description": "The handle of the publisher.",
      "type": "string"
    },
    "organizerName": {
      "description": "The display name of the publisher.",
      "type": "string"
    },
    "rsvpCounts": {
      "ref": "app.rocksky.event.defs#rsvpCounts",
      "type": "ref"
    },
    "startsAt": {
      "description": "When the event starts.",
      "format": "datetime",
      "type": "string"
    },
    "status": {
      "description": "The event status, as a community.lexicon.calendar.event#status token.",
      "knownValues": [
        "community.lexicon.calendar.event#planned",
        "community.lexicon.calendar.event#scheduled",
        "community.lexicon.calendar.event#rescheduled",
        "community.lexicon.calendar.event#cancelled",
        "community.lexicon.calendar.event#postponed"
      ],
      "type": "string"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "ticketsUrl": {
      "description": "Where tickets can be bought.",
      "format": "uri",
      "type": "string"
    },
    "updatedAt": {
      "description": "When the event was last indexed.",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "description": "AT-URI of the community.lexicon.calendar.event record.",
      "format": "at-uri",
      "type": "string"
    },
    "uris": {
      "description": "Links associated with the event.",
      "items": {
        "ref": "app.rocksky.event.defs#uriView",
        "type": "ref"
      },
      "type": "array"
    },
    "viewerRsvp": {
      "description": "The authenticated viewer's RSVP, as a community.lexicon.calendar.rsvp status token. Absent when not authenticated or when the viewer has not responded.",
      "knownValues": [
        "community.lexicon.calendar.rsvp#going",
        "community.lexicon.calendar.rsvp#interested",
        "community.lexicon.calendar.rsvp#notgoing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "uri",
    "musicUri",
    "name",
    "artists",
    "locations",
    "uris",
    "rsvpCounts",
    "organizerDid",
    "createdAt",
    "updatedAt"
  ],
  "type": "object"
}
locationView object

One entry of the calendar event's locations, flattened: `type` says which community.lexicon.location shape it came from, and only the fields of that shape are set.

Properties

altitude string Optional

No description available.

country string Optional

ISO 3166 country code.

fsqPlaceId string Optional

Foursquare Open Source Places id.

h3 string Optional

H3 encoded location.

latitude string Optional

No description available.

locality string Optional

City or town.

longitude string Optional

No description available.

name string Optional

The name of the location (venue name).

postalCode string Optional

No description available.

region string Optional

No description available.

street string Optional

No description available.

type string Required

No description available.

Known values: community.lexicon.location.address, community.lexicon.location.geo, community.lexicon.location.fsq, community.lexicon.location.hthree, community.lexicon.calendar.event#uri
uri string uri Optional

A URL standing in for the location (online events).

View raw schema
{
  "description": "One entry of the calendar event's locations, flattened: `type` says which community.lexicon.location shape it came from, and only the fields of that shape are set.",
  "properties": {
    "altitude": {
      "type": "string"
    },
    "country": {
      "description": "ISO 3166 country code.",
      "type": "string"
    },
    "fsqPlaceId": {
      "description": "Foursquare Open Source Places id.",
      "type": "string"
    },
    "h3": {
      "description": "H3 encoded location.",
      "type": "string"
    },
    "latitude": {
      "type": "string"
    },
    "locality": {
      "description": "City or town.",
      "type": "string"
    },
    "longitude": {
      "type": "string"
    },
    "name": {
      "description": "The name of the location (venue name).",
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "street": {
      "type": "string"
    },
    "type": {
      "knownValues": [
        "community.lexicon.location.address",
        "community.lexicon.location.geo",
        "community.lexicon.location.fsq",
        "community.lexicon.location.hthree",
        "community.lexicon.calendar.event#uri"
      ],
      "type": "string"
    },
    "uri": {
      "description": "A URL standing in for the location (online events).",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}
rsvpCounts object

No description available.

Properties

going integer Required

No description available.

minimum: 0
interested integer Required

No description available.

minimum: 0
notGoing integer Required

No description available.

minimum: 0
View raw schema
{
  "properties": {
    "going": {
      "minimum": 0,
      "type": "integer"
    },
    "interested": {
      "minimum": 0,
      "type": "integer"
    },
    "notGoing": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "going",
    "interested",
    "notGoing"
  ],
  "type": "object"
}
rsvpView object

A community.lexicon.calendar.rsvp on an event, with its author.

Properties

avatar string uri Optional

A valid URI.

cid string cid Optional

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

displayName string Required

No description available.

handle string Required

No description available.

status string Required

No description available.

Known values: community.lexicon.calendar.rsvp#going, community.lexicon.calendar.rsvp#interested, community.lexicon.calendar.rsvp#notgoing
uri string at-uri Required

AT-URI of the rsvp record.

View raw schema
{
  "description": "A community.lexicon.calendar.rsvp on an event, with its author.",
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "handle": {
      "type": "string"
    },
    "status": {
      "knownValues": [
        "community.lexicon.calendar.rsvp#going",
        "community.lexicon.calendar.rsvp#interested",
        "community.lexicon.calendar.rsvp#notgoing"
      ],
      "type": "string"
    },
    "uri": {
      "description": "AT-URI of the rsvp record.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "status",
    "did",
    "handle",
    "displayName",
    "createdAt"
  ],
  "type": "object"
}
uriView object

No description available.

Properties

name string Optional

The display name of the URI.

uri string uri Required

A valid URI.

View raw schema
{
  "properties": {
    "name": {
      "description": "The display name of the URI.",
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri"
  ],
  "type": "object"
}

Lexicon Garden

@