Ably · Schema

key_patch

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
name string The name for your API key. This is a friendly name for your reference.
capability object These are the capability operations described in the Ably capabilities docs.
View JSON Schema on GitHub

JSON Schema

ably-key-patch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/key_patch",
  "title": "key_patch",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "The name for your API key. This is a friendly name for your reference.",
      "type": "string",
      "example": "My key name"
    },
    "capability": {
      "description": "These are the capability operations described in the Ably <a href=\"https://ably.com/docs/auth/capabilities\">capabilities docs</a>.",
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "description": "An array of strings setting the capability operations for the resource.",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "example": {
    "name": "My key name",
    "capability": {
      "channel1": [
        "publish",
        "subscribe"
      ],
      "channel2": [
        "history"
      ]
    }
  }
}