# fyi.opensocial.previewSiteDraft

> 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.previewSiteDraft)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.previewSiteDraft/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.previewSiteDraft/examples)

## Definitions

### `fyi.opensocial.previewSiteDraft`

**Type**: `query`

Every public page of the group's site as the caller's draft would publish it.

#### Parameters

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

#### Output

**Encoding**: `application/json`

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

#### Errors

- **NotFound**
- **Forbidden**
- **MethodFailed**

### `fyi.opensocial.previewSiteDraft#page`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `channel` | `string` | Yes |  |
| `html` | `string` | Yes |  |
| `path` | `string` | Yes |  |
| `status` | `integer` | Yes |  |
| `tab` | `string` | Yes |  |
| `warning` | `string` | No |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Every public page of the group's site as the caller's draft would publish it.",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "Forbidden"
        },
        {
          "name": "MethodFailed"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "pages": {
              "items": {
                "ref": "#page",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "pages"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "page": {
      "properties": {
        "channel": {
          "type": "string"
        },
        "html": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "status": {
          "type": "integer"
        },
        "tab": {
          "type": "string"
        },
        "warning": {
          "type": "string"
        }
      },
      "required": [
        "channel",
        "tab",
        "path",
        "status",
        "html"
      ],
      "type": "object"
    }
  },
  "id": "fyi.opensocial.previewSiteDraft",
  "lexicon": 1
}
```