cards.sunshine.getDraft

sunshine.cards

Documentation

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.

main query

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.

Parameters

card integer Optional

Ask for just the card at this position.

uri string at-uri Required

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

Output

Encodingapplication/json
cards array Required

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

createdAt stringdatetime Required

An RFC 3339 formatted timestamp.

explainer string Optional

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

set unknown Required

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.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Ask for just the card at this position.
The cards.sunshine.draft record, in its creator's deck.
View raw schema 
{
  "description": "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.",
  "errors": [
    {
      "description": "There's no such draft, or the viewer may see none of it.",
      "name": "DraftNotFound"
    },
    {
      "description": "The creator's deck can't be reached right now.",
      "name": "CreatorUnavailable"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cards": {
          "description": "The draft's cards, in order. Asked for one card, just that one.",
          "items": {
            "ref": "#card",
            "type": "ref"
          },
          "maxLength": 500,
          "type": "array"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "explainer": {
          "description": "The draft's note to reviewers, in Markdown (CommonMark).",
          "maxGraphemes": 10000,
          "maxLength": 100000,
          "type": "string"
        },
        "set": {
          "description": "The draft's cards.sunshine.set record.",
          "type": "unknown"
        }
      },
      "required": [
        "set",
        "cards",
        "createdAt"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "card": {
        "description": "Ask for just the card at this position.",
        "maximum": 499,
        "minimum": 0,
        "type": "integer"
      },
      "uri": {
        "description": "The cards.sunshine.draft record, in its creator's deck.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "uri"
    ],
    "type": "params"
  },
  "type": "query"
}
card object

No description available.

Properties

back string uri Optional

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

card unknown Optional

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

front string uri Optional

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

index integer Required

The card's position in the draft.

minimum: 0maximum: 499
View raw schema 
{
  "properties": {
    "back": {
      "description": "A short-lived URL of the card's back artwork.",
      "format": "uri",
      "type": "string"
    },
    "card": {
      "description": "The card's cards.sunshine.card record. Present only when the viewer may see it.",
      "type": "unknown"
    },
    "front": {
      "description": "A short-lived URL of the card's front artwork.",
      "format": "uri",
      "type": "string"
    },
    "index": {
      "description": "The card's position in the draft.",
      "maximum": 499,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "index"
  ],
  "type": "object"
}

Lexicon Garden

@