fyi.opensocial.getSiteDraft

lexicons.opensocial.fyi

Documentation

The caller's draft of the group's site, if they have one, and whether the site's last publish can be undone. Only for whoever may change the site.

main query

The caller's draft of the group's site, if they have one, and whether the site's last publish can be undone. Only for whoever may change the site.

Parameters

group string did Required

A decentralized identifier (DID).

Output

Encodingapplication/json

draft ref#draft Optional

No description available.

undo ref#undo Optional

No description available.

Errors

Forbidden

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

group * A decentralized identifier (DID).

View raw schema

{
  "description": "The caller's draft of the group's site, if they have one, and whether the site's last publish can be undone. Only for whoever may change the site.",
  "errors": [
    {
      "name": "Forbidden"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "draft": {
          "ref": "#draft",
          "type": "ref"
        },
        "undo": {
          "ref": "#undo",
          "type": "ref"
        }
      },
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "group": {
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "group"
    ],
    "type": "params"
  },
  "type": "query"
}

draft object

No description available.

Properties

avatar string uri Optional

The group's picture, as the draft changes it.

banner string uri Optional

Its banner, as the draft changes it.

by string Required

Who made the last change to it: an AI app's name.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

What the group says about itself, as the draft changes it.

joinPolicy string Optional

How people join, as the draft changes it.

name string Optional

The group's name, as the draft changes it.

rules array of ref#rule Optional

The group's rules, as the draft has them.

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

uri string at-uri Required

The draft's site record, in the members space.

View raw schema

{
  "properties": {
    "avatar": {
      "description": "The group's picture, as the draft changes it.",
      "format": "uri",
      "type": "string"
    },
    "banner": {
      "description": "Its banner, as the draft changes it.",
      "format": "uri",
      "type": "string"
    },
    "by": {
      "description": "Who made the last change to it: an AI app's name.",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "description": "What the group says about itself, as the draft changes it.",
      "type": "string"
    },
    "joinPolicy": {
      "description": "How people join, as the draft changes it.",
      "type": "string"
    },
    "name": {
      "description": "The group's name, as the draft changes it.",
      "type": "string"
    },
    "rules": {
      "description": "The group's rules, as the draft has them.",
      "items": {
        "ref": "#rule",
        "type": "ref"
      },
      "type": "array"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "description": "The draft's site record, in the members space.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "by",
    "updatedAt",
    "uri"
  ],
  "type": "object"
}

rule object

No description available.

Properties

text string Optional

No description available.

title string Required

No description available.

View raw schema

{
  "properties": {
    "text": {
      "type": "string"
    },
    "title": {
      "type": "string"
    }
  },
  "required": [
    "title"
  ],
  "type": "object"
}

undo object

No description available.

Properties

mine boolean Required

No description available.

publishedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema

{
  "properties": {
    "mine": {
      "type": "boolean"
    },
    "publishedAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "publishedAt",
    "mine"
  ],
  "type": "object"
}