Lexicon Garden

cards.sunshine.getDraft

Shows a draft set to someone asked to review it. Called through the viewer's PDS (service auth). The viewer sees the cards meant for them; the rest are just their positions. A draft the viewer may see none of answers DraftNotFound, as a missing one does.

Repository @sunshine.cards did:web:sunshine.cards namespace authority
Details · query
Kindquery
Authoritysunshine.cards
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

card

integer

Ask for just the card at this position.

  • minimum: 0
  • maximum: 499

uri

requiredstring · at-uri

The cards.sunshine.draft record, in its creator's deck.

Output

application/json

cards

requiredarray

The draft's cards, in order. Asked for one card, just that one.

  • maxLength: 500
itemsref
Reference

createdAt

requiredstring · datetime

explainer

string

The draft's note to reviewers, in Markdown (CommonMark).

  • maxLength: 100000
  • maxGraphemes: 10000

set

requiredunknown

The draft's cards.sunshine.set record.

Errors

DraftNotFound

There's no such draft, or the viewer may see none of it.

CreatorUnavailable

The creator's deck can't be reached right now.

#card

object

Properties

back

string · uri

A short-lived URL of the card's back artwork.

card

unknown

The card's cards.sunshine.card record. Present only when the viewer may see it.

front

string · uri

A short-lived URL of the card's front artwork.

index

requiredinteger

The card's position in the draft.

  • minimum: 0
  • maximum: 499

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.