Zoho Cliq Extensions Schemas

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Zoho Cliq Extensions Schemas",
  "definitions": {
    "ExtensionPropertySingleResponse": {
      "type": "object",
      "description": "Response returned when retrieving a single extension property.",
      "properties": {
        "api_key": {
          "type": "string",
          "example": "my_secret_api_key_value"
        }
      },
      "example": {
        "api_key": "my_secret_api_key_value"
      }
    },
    "ExtensionPropertiesGetResponse": {
      "type": "object",
      "description": "Response returned when retrieving multiple extension properties. Keys are property names; values are their current string values.",
      "properties": {
        "api_key": {
          "type": "string",
          "example": "my_secret_api_key_value"
        },
        "region": {
          "type": "string",
          "example": "us-east"
        },
        "max_retries": {
          "type": "string",
          "example": "3"
        }
      },
      "example": {
        "api_key": "my_secret_api_key_value",
        "region": "us-east",
        "max_retries": "3"
      }
    },
    "ExtensionPropertiesUpdateResponse": {
      "type": "object",
      "description": "Response returned after adding or updating extension properties. Contains only the key-value pairs that were submitted in the request.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "api_key": "my_secret_api_key_value"
      }
    },
    "longid_regex": {
      "type": "string",
      "description": "Numeric long integer identifier used to reference platform components such as Commands, Functions, Widgets, Message Actions, Schedulers, and Extensions."
    },
    "extensioninstall_V3": {
      "type": "object",
      "description": "Payload for installing an extension.",
      "required": [
        "scope"
      ],
      "properties": {
        "scope": {
          "type": "string",
          "enum": [
            "organization",
            "team"
          ],
          "description": "Installlation scope for the extension.<br>\n<b>Allowable values</b>:<br>\n<ul>\n  <li><code>organization</code>: Extension will be available to all users within the organization. Requires admin consent.</li>\n  <li><code>team</code>: Extension will be available only to users within specified teams. Requires admin consent for each team.</li>\n</ul>\n"
        },
        "team_ids": {
          "type": "array",
          "maxItems": 4,
          "description": "List of <a href=\"/cliq/help/restapi/v3/glossary/#TEAM_ID\">team_ids</a> to which the extension should be installed. Required if scope is set to <code>team</code>. Maximum of 4 team IDs allowed.\n",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "encryptedappkey_regex": {
      "type": "string",
      "description": "Encrypted application key (appkey or EXTENSION_KEY) issued to a bot or extension, used as an alternative to OAuth for webhook-style authentication."
    },
    "extensionupgrade_V3": {
      "type": "object",
      "description": "Payload for upgrading an installed extension.",
      "required": [
        "scope"
      ],
      "properties": {
        "scope": {
          "type": "string",
          "enum": [
            "organization",
            "team"
          ],
          "description": "Upgrade scope for the extension."
        }
      }
    },
    "appproperties": {
      "type": "object",
      "description": "Payload for setting extension properties.",
      "required": [
        "properties"
      ],
      "properties": {
        "properties": {
          "type": "object",
          "description": "Map of extension property keys to values.",
          "properties": {
            "api_key": {
              "type": "string",
              "example": "my_secret_api_key_value"
            }
          }
        }
      }
    },
    "smallalphawithspl_regex": {
      "type": "string",
      "description": "Lowercase alphanumeric string with allowed special characters (hyphens and underscores) used as extension property keys."
    }
  }
}