# fyi.atstore.server.describe

> Published by [atstore.fyi](https://lexicon.garden/identity/did:plc:dvy6bdnofdfc4php4s5b457d)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:dvy6bdnofdfc4php4s5b457d/fyi.atstore.server.describe)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dvy6bdnofdfc4php4s5b457d/fyi.atstore.server.describe/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dvy6bdnofdfc4php4s5b457d/fyi.atstore.server.describe/examples)

## Definitions

### `fyi.atstore.server.describe`

**Type**: `query`

Describe this deployment's public XRPC surface and defaults.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `methods` | `array` | Yes |  |
| `service` | `string` | Yes |  |
| `publicReads` | `boolean` | Yes |  |
| `maxReviewLimit` | `integer` | Yes |  |
| `maxListingLimit` | `integer` | Yes |  |
| `defaultListingLimit` | `integer` | Yes |  |
| `reviewsWrittenOnAuthorRepo` | `boolean` | Yes | When true, listing reviews are created via com.atproto.repo.createRecord on the author's PDS (fyi.atstore.listing.review); this service does not expose a write procedure for reviews. |

## Raw Schema

```json
{
  "id": "fyi.atstore.server.describe",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "service",
            "publicReads",
            "reviewsWrittenOnAuthorRepo",
            "defaultListingLimit",
            "maxListingLimit",
            "maxReviewLimit",
            "methods"
          ],
          "properties": {
            "methods": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 512
              }
            },
            "service": {
              "type": "string",
              "maxLength": 256
            },
            "publicReads": {
              "type": "boolean"
            },
            "maxReviewLimit": {
              "type": "integer"
            },
            "maxListingLimit": {
              "type": "integer"
            },
            "defaultListingLimit": {
              "type": "integer"
            },
            "reviewsWrittenOnAuthorRepo": {
              "type": "boolean",
              "description": "When true, listing reviews are created via com.atproto.repo.createRecord on the author's PDS (fyi.atstore.listing.review); this service does not expose a write procedure for reviews."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {}
      },
      "description": "Describe this deployment's public XRPC surface and defaults."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```