Canonical · Schema

PromptingReply

CanonicalCloudLinuxOpen SourceUbuntuContainersBare MetalCharmsIdentity

Properties

Name Type Description
action string
lifespan string The lifespan for which the decision applies. single: the decision only applies to the prompt with the given ID timespan: the decision creates a rule which applies for the duration specified by the dur
duration string The duration for which the decision applies. Required if lifespan is timespan, otherwise must be omitted.
constraints object
View JSON Schema on GitHub

JSON Schema

canonical-prompting-reply-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/canonical/main/json-schema/canonical-prompting-reply-schema.json",
  "title": "PromptingReply",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/canonical-experimental-api-openapi.yml#/components/schemas/PromptingReply",
  "type": "object",
  "required": [
    "action",
    "lifespan",
    "constraints"
  ],
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "allow",
        "deny"
      ]
    },
    "lifespan": {
      "type": "string",
      "description": "The lifespan for which the decision applies.\n\nsingle: the decision only applies to the prompt with the given ID\n\ntimespan: the decision creates a rule which applies for the duration\nspecified by the duration field or until it is deleted\n\nsession: the decision creates a rule which applies until the user logs\nout (specifically, until the systemd user session ends)\n\nforever: the decision creates a rule which applies until it is deleted",
      "enum": [
        "single",
        "timespan",
        "session",
        "forever"
      ]
    },
    "duration": {
      "type": "string",
      "description": "The duration for which the decision applies. Required if lifespan is\ntimespan, otherwise must be omitted.",
      "format": "Go duration"
    },
    "constraints": {
      "oneOf": [
        {
          "$ref": "#/$defs/PromptingReplyConstraintsCamera"
        },
        {
          "$ref": "#/$defs/PromptingReplyConstraintsHome"
        }
      ]
    }
  },
  "$defs": {
    "PromptingReplyConstraintsCamera": {
      "type": "object",
      "description": "Represents the constraints associated with a reply to a prompt for the camera interface.",
      "required": [
        "permissions"
      ],
      "properties": {
        "permissions": {
          "type": "array",
          "description": "The permissions applied to requests to access cameras via the camera interface.",
          "items": {
            "type": "string",
            "enum": [
              "access"
            ]
          }
        }
      }
    },
    "PromptingReplyConstraintsHome": {
      "type": "object",
      "description": "Represents the constraints associated with a reply to a prompt for the home interface.",
      "required": [
        "path-pattern",
        "permissions"
      ],
      "properties": {
        "path-pattern": {
          "type": "string",
          "description": "Path glob matching filepaths for which the reply applies, which must\nmatch (in the globstar sense) the originally-requested path, must\nbegin with /, and may include bash-like constructions such as *, /**/,\nand {a,b}, but must not include character classes of the form [abc] or\n[^abc]."
        },
        "permissions": {
          "type": "array",
          "description": "The permission applied to files matching the path glob in\n'path-pattern'.",
          "items": {
            "type": "string",
            "enum": [
              "read",
              "write",
              "execute"
            ]
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/canonical-prompting-reply"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.