# garden.engram.describeService

> Published by [hailey.at](https://lexicon.garden/identity/did:plc:oisofpd7lj26yvgiivf3lxsi)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:oisofpd7lj26yvgiivf3lxsi/garden.engram.describeService)
- [Documentation](https://lexicon.garden/lexicon/did:plc:oisofpd7lj26yvgiivf3lxsi/garden.engram.describeService/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:oisofpd7lj26yvgiivf3lxsi/garden.engram.describeService/examples)

## Definitions

### `garden.engram.describeService`

**Type**: `query`

How to have a space indexed by this appview. No authentication.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | The service DID requests are addressed to. |
| `grantUrl` | `string` (uri) | No | Where a space's authority lets the appview read the space, so it indexes it. Open it in a browser with ?space=<space URI>&mode=grant (or mode=stop to take that back) and optionally return=<URL to come back to>, on an origin the appview allows. |
| `registration` | `string` | Yes | open: any space's authority can have it indexed at grantUrl. closed: only the spaces the operator chooses. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "How to have a space indexed by this appview. No authentication.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "did": {
              "description": "The service DID requests are addressed to.",
              "format": "did",
              "type": "string"
            },
            "grantUrl": {
              "description": "Where a space's authority lets the appview read the space, so it indexes it. Open it in a browser with ?space=<space URI>&mode=grant (or mode=stop to take that back) and optionally return=<URL to come back to>, on an origin the appview allows.",
              "format": "uri",
              "type": "string"
            },
            "registration": {
              "description": "open: any space's authority can have it indexed at grantUrl. closed: only the spaces the operator chooses.",
              "knownValues": [
                "open",
                "closed"
              ],
              "type": "string"
            }
          },
          "required": [
            "did",
            "registration"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "garden.engram.describeService",
  "lexicon": 1
}
```