Package-level declarations

Types

Link copied to clipboard
data class GetBlobQueryParams(val did: Did, val cid: Cid)
Link copied to clipboard
data class GetBlocksQueryParams(val did: Did, val cids: List<Cid>)
Link copied to clipboard
Link copied to clipboard
data class GetHeadQueryParams(val did: Did)
Link copied to clipboard
data class GetHeadResponse(val root: Cid)
Link copied to clipboard
Link copied to clipboard
data class GetLatestCommitResponse(val cid: Cid, val rev: String)
Link copied to clipboard
data class GetRecordQueryParams(val did: Did, val collection: Nsid, val rkey: String, val commit: Cid? = null)
Link copied to clipboard
data class GetRepoQueryParams(val did: Did, val since: String? = null)
Link copied to clipboard
Link copied to clipboard
data class GetRepoStatusResponse(val did: Did, val active: Boolean, val status: GetRepoStatusStatus? = null, val rev: String? = null)
Link copied to clipboard

If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

Link copied to clipboard
data class ListBlobsQueryParams(val did: Did, val since: String? = null, val limit: Long? = 500, val cursor: String? = null)
Link copied to clipboard
data class ListBlobsResponse(val cursor: String? = null, val cids: List<Cid>)
Link copied to clipboard
data class ListReposQueryParams(val limit: Long? = 500, val cursor: String? = null)
Link copied to clipboard
data class ListReposRepo(val did: Did, val head: Cid, val rev: String, val active: Boolean? = null, val status: ListReposStatus? = null)
Link copied to clipboard
data class ListReposResponse(val cursor: String? = null, val repos: List<ListReposRepo>)
Link copied to clipboard

If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

Link copied to clipboard
data class NotifyOfUpdateRequest(val hostname: String)
Link copied to clipboard
data class RequestCrawlRequest(val hostname: String)
Link copied to clipboard
data class SubscribeReposAccount(val seq: Long, val did: Did, val time: Timestamp, val active: Boolean, val status: SubscribeReposStatus? = null)

Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.

Link copied to clipboard
data class SubscribeReposCommit(val seq: Long, val rebase: Boolean, val tooBig: Boolean, val repo: Did, val commit: ByteArray, val prev: ByteArray? = null, val rev: String, val since: String? = null, val blocks: ByteArray, val ops: List<SubscribeReposRepoOp>, val blobs: List<ByteArray>, val time: Timestamp)

Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.

Link copied to clipboard
data class SubscribeReposHandle(val seq: Long, val did: Did, val handle: Handle, val time: Timestamp)
Link copied to clipboard
data class SubscribeReposIdentity(val seq: Long, val did: Did, val time: Timestamp, val handle: Handle? = null)

Represents a change to an account's identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache.

Link copied to clipboard
data class SubscribeReposInfo(val name: SubscribeReposName, val message: String? = null)
Link copied to clipboard
Link copied to clipboard
data class SubscribeReposMigrate(val seq: Long, val did: Did, val migrateTo: String? = null, val time: Timestamp)
Link copied to clipboard
data class SubscribeReposQueryParams(val cursor: Long? = null)
Link copied to clipboard
data class SubscribeReposRepoOp(val action: SubscribeReposAction, val path: String, val cid: ByteArray? = null)

A repo operation, ie a mutation of a single record.

Link copied to clipboard

If active=false, this optional field indicates a reason for why the account is not active.

Link copied to clipboard
data class SubscribeReposTombstone(val seq: Long, val did: Did, val time: Timestamp)