garden.engram.describeService Documentation (EN)

main query

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

Output

Encodingapplication/json

did stringdid Required

The service DID requests are addressed to.

grantUrl stringuri Optional

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 Required

open: any space's authority can have it indexed at grantUrl. closed: only the spaces the operator chooses.

Known values: open, closed

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)

View raw schema

{
  "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"
}