# fyi.opensocial.listDrafts

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listDrafts)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listDrafts/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listDrafts/examples)

## Definitions

### `fyi.opensocial.listDrafts#draftFile`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `alt` | `string` | No | What it shows, in words. |
| `n` | `integer` | Yes | Its number, from 1. |
| `size` | `integer` | Yes | How big it is, in bytes. |
| `type` | `string` | Yes | Its MIME type. |

### `fyi.opensocial.listDrafts#draftView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `asGroup` | `boolean` | No | Added as the group, by whoever adds it and may. |
| `by` | `string` | No | The AI app that left it, by the name it gave. |
| `collection` | `string` (nsid) | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `files` | `array` | No | The files it brings, in order: each read with getDraftFile, by its number. |
| `id` | `string` | Yes |  |
| `page` | `boolean` | No | Its tab's page makes it into what it keeps. |
| `record` | `unknown` | Yes |  |
| `remove` | `boolean` | No | It removes that one, rather than changing it. |
| `replaces` | `string` | No | The one it changes, or removes: the record's address, or, for its tab's page to change, as the page names one. |
| `space` | `string` | No | The space it goes in, added. |
| `tab` | `string` | Yes | Its tab's namespace. |
| `title` | `string` | Yes |  |
| `was` | `string` | No | What the one it changes or removes is called. |

### `fyi.opensocial.listDrafts`

**Type**: `query`

The drafts your assistant left for you in the group's tabs, waiting for you to add or let go: each with the space it goes in, added as you, or for its tab's page to make into what it keeps (page).

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `group` | `string` (did) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `drafts` | `array` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "draftFile": {
      "properties": {
        "alt": {
          "description": "What it shows, in words.",
          "type": "string"
        },
        "n": {
          "description": "Its number, from 1.",
          "minimum": 1,
          "type": "integer"
        },
        "size": {
          "description": "How big it is, in bytes.",
          "type": "integer"
        },
        "type": {
          "description": "Its MIME type.",
          "type": "string"
        }
      },
      "required": [
        "n",
        "type",
        "size"
      ],
      "type": "object"
    },
    "draftView": {
      "properties": {
        "asGroup": {
          "description": "Added as the group, by whoever adds it and may.",
          "type": "boolean"
        },
        "by": {
          "description": "The AI app that left it, by the name it gave.",
          "type": "string"
        },
        "collection": {
          "format": "nsid",
          "type": "string"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "files": {
          "description": "The files it brings, in order: each read with getDraftFile, by its number.",
          "items": {
            "ref": "#draftFile",
            "type": "ref"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "page": {
          "description": "Its tab's page makes it into what it keeps.",
          "type": "boolean"
        },
        "record": {
          "type": "unknown"
        },
        "remove": {
          "description": "It removes that one, rather than changing it.",
          "type": "boolean"
        },
        "replaces": {
          "description": "The one it changes, or removes: the record's address, or, for its tab's page to change, as the page names one.",
          "type": "string"
        },
        "space": {
          "description": "The space it goes in, added.",
          "type": "string"
        },
        "tab": {
          "description": "Its tab's namespace.",
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "was": {
          "description": "What the one it changes or removes is called.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "tab",
        "collection",
        "title",
        "record",
        "createdAt"
      ],
      "type": "object"
    },
    "main": {
      "description": "The drafts your assistant left for you in the group's tabs, waiting for you to add or let go: each with the space it goes in, added as you, or for its tab's page to make into what it keeps (page).",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "drafts": {
              "items": {
                "ref": "#draftView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "drafts"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.listDrafts",
  "lexicon": 1
}
```
