Expand description
The JSON shapes the XRPC routes read and write.
These types exist separately from the engine’s types on purpose. The engine
speaks OffsetDateTime and Vec<u8>; the wire speaks RFC 3339 and hex.
Keeping the conversion in one place means a field can be renamed in the
engine without silently renaming it for every client.
Structs§
- Account
Summary - One entry in the
listAccountsresponse. - Apply
Writes Request - Body of
com.atproto.repo.applyWrites. - Approve
Authorization Request - Body of
bot.did.approveAuthorization. - Blobs
View - The
blobsmember ofStatsResponse: this deployment’s blobs, by the state each one is in. - Create
Account Request - Body of
bot.did.createAccount. - Create
Record Request - Body of
com.atproto.repo.createRecord. - Create
Record Response - Response of
com.atproto.repo.createRecord. - Decline
Authorization Request - Body of
bot.did.declineAuthorization. - Delete
Record Request - Body of
com.atproto.repo.deleteRecord. - Describe
Repo Query - Query of
com.atproto.repo.describeRepo. - Describe
Repo Response - Response of
com.atproto.repo.describeRepo. - Describe
Server Response - Response of
com.atproto.server.describeServer. - DidRequest
- Body of
bot.did.deleteAccount, and of the freeze and deactivate routes and their inverses. - Fragment
- Text for one slot of a pool’s naming scheme.
- GetBlob
Query - Query of
com.atproto.sync.getBlob. - GetRecord
Query - Query of
com.atproto.repo.getRecord. - GetRecord
Response - Response of
com.atproto.repo.getRecord. - GetRepo
Query - Query of
com.atproto.sync.getRepo. - Ledger
Query - Query of
bot.did.getAccountLedger. - Lifecycle
Line - What this deployment is doing right now, for a reader with no credential.
- List
Blobs Query - Query of
com.atproto.sync.listBlobs. - List
Records Query - Query of
com.atproto.repo.listRecords. - List
Repos Query - Query of
com.atproto.sync.listRepos. - Park
KeyRequest - Body of
bot.did.parkKey. - Parked
KeyQuery - Query of
bot.did.describeParkedKey. - Policy
Binding View - One
bot.did.policyBindingrecord in force, and whom it reaches. - Policy
Record View - One
bot.did.policyrecord in force. - Policy
Refusal View - One record a build would not honour, and why.
- Policy
View - The
policymember ofStatsResponse. - PutRecord
Request - Body of
com.atproto.repo.putRecord. - Record
View - One entry in the
listRecordsresponse. - Session
Query - Query of
bot.did.createSession. - Stats
Response - Response of
bot.did.stats. - Swap
- The compare-and-swap fields, as they arrive on the wire.
- Sync
GetRecord Query - Query of
com.atproto.sync.getRecord. - Tally
View - How many blobs, and what they occupy.
- Tree
View - The
treemember ofStatsResponse: one field per[tree]key, spelled the way the key is.
Enums§
- Account
Proof - What the account’s own DID document offers a stranger as proof of being
it, beside the
#atprotokey this server signs its commits with. - Edge
State - Whether the edge from an account to its operator still stands.
- Repo
Write - One operation in a
com.atproto.repo.applyWritesbatch. - Write
Result - One entry in the
applyWritesresults, one per write, in order.
Constants§
- DEFAULT_
REPO_ LIMIT - The default page size
com.atproto.sync.listReposdeclares. - MAX_
APPLY_ WRITES - The most writes one
com.atproto.repo.applyWritesbatch may carry. - MAX_
LIST_ LIMIT - The most records
listRecordswill return in one answer. - MAX_
REPO_ LIMIT - The largest page
com.atproto.sync.listReposdeclares.
Functions§
- parse_
kind - The kind a request names, or a 400 naming what it accepts.
- parse_
swap_ 🔒cid - Decodes a swap field, or refuses the request.
- percent_
decode 🔒 - Percent-decoding, with
+as a space, as a query string is written. - present 🔒
- Reads a field that may be present and
null. - record_
uri - The
at://URI naming one record. - refuse_
skipped_ validation - The
validateflag, which is atproto’s own name for the three stances. - repeated
- Every value given for
keyin a raw query string, in the order they appear. - require_
known_ lexicon - The pre-check
validate: trueasks for, which is the explicit stance for one request.