fyi.opensocial.getPageDraft

lexicons.opensocial.fyi

Documentation

The page the caller's assistant left for one of the site's tabs (which needs group.configure) or for one of the caller's own pages, if any, and the caller's assistants connected to the group. Only the caller's own: nobody sees another member's drafts.

main query

The page the caller's assistant left for one of the site's tabs (which needs group.configure) or for one of the caller's own pages, if any, and the caller's assistants connected to the group. Only the caller's own: nobody sees another member's drafts.

Parameters

channel string Optional

A tab's channel.

group string did Required

A decentralized identifier (DID).

tab string Optional

The tab.

work string Optional

Instead of a tab, one of the caller's own pages, by its key: profile, one of theirs, or new.

Output

Encodingapplication/json
assistants array Required

No description available.

draft ref#draft Optional

No description available.

Errors

Forbidden
NotFound
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
A tab's channel.
A decentralized identifier (DID).
The tab.
Instead of a tab, one of the caller's own pages, by its key: profile, one of theirs, or new.
View raw schema 
{
  "description": "The page the caller's assistant left for one of the site's tabs (which needs group.configure) or for one of the caller's own pages, if any, and the caller's assistants connected to the group. Only the caller's own: nobody sees another member's drafts.",
  "errors": [
    {
      "name": "Forbidden"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "assistants": {
          "items": {
            "ref": "#assistant",
            "type": "ref"
          },
          "type": "array"
        },
        "draft": {
          "ref": "#draft",
          "type": "ref"
        }
      },
      "required": [
        "assistants"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "channel": {
        "description": "A tab's channel.",
        "type": "string"
      },
      "group": {
        "format": "did",
        "type": "string"
      },
      "tab": {
        "description": "The tab.",
        "type": "string"
      },
      "work": {
        "description": "Instead of a tab, one of the caller's own pages, by its key: profile, one of theirs, or new.",
        "type": "string"
      }
    },
    "required": [
      "group"
    ],
    "type": "params"
  },
  "type": "query"
}
assistant object

No description available.

Properties

id string Required

No description available.

name string Required

No description available.

usedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "usedAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "usedAt"
  ],
  "type": "object"
}
draft object

No description available.

Properties

by string Required

The assistant that made it.

html string Required

No description available.

lexicons array of unknown Optional

For a tab's page: lexicons of the group's own it brings, which publishing defines.

network array of stringnsid Optional

For a tab's page: the collections it reads from everyone on the network, which publishing it puts on the tab.

maxLength: 20 items
reads array of stringnsid Optional

For a tab's page: the kinds of record it reads from the group's spaces, which publishing puts on the tab.

savedAt string datetime Required

An RFC 3339 formatted timestamp.

size integer Required

No description available.

spaces array of stringnsid Optional

For a tab's page: kinds of space it keeps its records in, one of each made for its tab when it's published.

title string Optional

For a new page of their own: what the assistant called it.

writes array of stringnsid Optional

For a tab's page: the kinds of record it writes for the viewer, which publishing puts on the tab.

View raw schema 
{
  "properties": {
    "by": {
      "description": "The assistant that made it.",
      "type": "string"
    },
    "html": {
      "type": "string"
    },
    "lexicons": {
      "description": "For a tab's page: lexicons of the group's own it brings, which publishing defines.",
      "items": {
        "type": "unknown"
      },
      "type": "array"
    },
    "network": {
      "description": "For a tab's page: the collections it reads from everyone on the network, which publishing it puts on the tab.",
      "items": {
        "format": "nsid",
        "type": "string"
      },
      "maxLength": 20,
      "type": "array"
    },
    "reads": {
      "description": "For a tab's page: the kinds of record it reads from the group's spaces, which publishing puts on the tab.",
      "items": {
        "format": "nsid",
        "type": "string"
      },
      "type": "array"
    },
    "savedAt": {
      "format": "datetime",
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "spaces": {
      "description": "For a tab's page: kinds of space it keeps its records in, one of each made for its tab when it's published.",
      "items": {
        "format": "nsid",
        "type": "string"
      },
      "type": "array"
    },
    "title": {
      "description": "For a new page of their own: what the assistant called it.",
      "type": "string"
    },
    "writes": {
      "description": "For a tab's page: the kinds of record it writes for the viewer, which publishing puts on the tab.",
      "items": {
        "format": "nsid",
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "html",
    "savedAt",
    "by",
    "size"
  ],
  "type": "object"
}

Lexicon Garden

@