ConfigHub · Schema

FunctionInvocationsResponse

CompanyConfigurationDevOpsKubernetesGitOpsPlatform

Properties

Name Type Description
ConfigData string The resulting configuration data; present only when the invocation changed it
Conflicts object Mutation conflicts produced by writing the invocation's result, such as a path a guard withheld. Empty when nothing was withheld.
DataHash string SHA256 of the resulting configuration data, whether or not ConfigData is present
Diff object What the invocation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff.
Error object Error information if the function invocation failed
HasNewMutations boolean Functions produced new mutations (of type other than None)
Mutations object List of mutations in the same order as the resources in ConfigData
Mutators arraynull List of function invocation indices that resulted in mutations
OrganizationID string ID of the Unit's Organization
Outputs objectnull Map of output types to their corresponding output data as embedded JSON
RevisionID string ID of the Revision the configuration data is associated with
SpaceID string ID of the Unit's Space
SpaceSlug string Slug of the Unit's Space
Success boolean True if all functions executed successfully
TargetID string ID of the Unit's Target; optional
UnitID string ID of the Unit the configuration data is associated with
UnitSlug string Slug of the Unit
View JSON Schema on GitHub

JSON Schema

confighub-function-invocations-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/confighub/json-schema/confighub-function-invocations-response-schema.json",
  "title": "FunctionInvocationsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/confighub-function-api-openapi.yml#/components/schemas/FunctionInvocationsResponse",
  "type": "object",
  "properties": {
    "ConfigData": {
      "type": "string",
      "description": "The resulting configuration data; present only when the invocation changed it",
      "x-go-type-skip-optional-pointer": true
    },
    "Conflicts": {
      "allOf": [
        {
          "$ref": "#/$defs/MutationConflictList"
        }
      ],
      "description": "Mutation conflicts produced by writing the invocation's result, such as a path a guard withheld. Empty when nothing was withheld."
    },
    "DataHash": {
      "type": "string",
      "description": "SHA256 of the resulting configuration data, whether or not ConfigData is present",
      "x-go-type-skip-optional-pointer": true
    },
    "Diff": {
      "allOf": [
        {
          "$ref": "#/$defs/ConfigDiff"
        }
      ],
      "description": "What the invocation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff."
    },
    "Error": {
      "allOf": [
        {
          "$ref": "#/$defs/ResponseError"
        }
      ],
      "description": "Error information if the function invocation failed"
    },
    "HasNewMutations": {
      "type": "boolean",
      "description": "Functions produced new mutations (of type other than None)",
      "x-go-type-skip-optional-pointer": true
    },
    "Mutations": {
      "allOf": [
        {
          "$ref": "#/$defs/ResourceMutationList"
        }
      ],
      "description": "List of mutations in the same order as the resources in ConfigData"
    },
    "Mutators": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "integer"
      },
      "description": "List of function invocation indices that resulted in mutations",
      "x-go-type-skip-optional-pointer": true
    },
    "OrganizationID": {
      "type": "string",
      "description": "ID of the Unit's Organization",
      "format": "uuid",
      "x-go-type-skip-optional-pointer": true,
      "x-omitzero": true
    },
    "Outputs": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string",
        "format": "base64"
      },
      "description": "Map of output types to their corresponding output data as embedded JSON",
      "x-go-type-skip-optional-pointer": true
    },
    "RevisionID": {
      "type": "string",
      "description": "ID of the Revision the configuration data is associated with",
      "format": "uuid",
      "x-go-type-skip-optional-pointer": true,
      "x-omitzero": true
    },
    "SpaceID": {
      "type": "string",
      "description": "ID of the Unit's Space",
      "format": "uuid",
      "x-go-type-skip-optional-pointer": true,
      "x-omitzero": true
    },
    "SpaceSlug": {
      "type": "string",
      "description": "Slug of the Unit's Space",
      "x-go-type-skip-optional-pointer": true
    },
    "Success": {
      "type": "boolean",
      "description": "True if all functions executed successfully",
      "x-go-type-skip-optional-pointer": true
    },
    "TargetID": {
      "type": "string",
      "description": "ID of the Unit's Target; optional",
      "format": "uuid",
      "x-go-type-skip-optional-pointer": true,
      "x-omitzero": true
    },
    "UnitID": {
      "type": "string",
      "description": "ID of the Unit the configuration data is associated with",
      "format": "uuid",
      "x-go-type-skip-optional-pointer": true,
      "x-omitzero": true
    },
    "UnitSlug": {
      "type": "string",
      "description": "Slug of the Unit",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "$defs": {
    "ArrayElementAliasMap": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      }
    },
    "ArrayOrderMap": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "ConfigDiff": {
      "type": "object",
      "properties": {
        "Resources": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ResourceDiff"
          },
          "description": "One entry per resource that differs, in the To configuration's order; resources only on the From side follow where they were",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "ErrorItem": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string",
          "description": "A clear explanation of what went wrong",
          "x-go-type-skip-optional-pointer": true
        },
        "Item": {
          "type": "string",
          "description": "The name of the field, resource, or entity that the error relates to",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "ErrorMetadata": {
      "type": "object",
      "properties": {
        "EntityID": {
          "type": "string",
          "description": "Optional ID of the entity this error relates to",
          "x-go-type-skip-optional-pointer": true
        },
        "EntitySlug": {
          "type": "string",
          "description": "Optional slug of the entity this error relates to",
          "x-go-type-skip-optional-pointer": true
        },
        "EntityType": {
          "type": "string",
          "description": "Optional type of the entity this error relates to",
          "x-go-type-skip-optional-pointer": true
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ErrorItem"
          },
          "description": "Collection of error details",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "GuardDelta": {
      "type": "object",
      "properties": {
        "Path": {
          "type": "string",
          "description": "The path whose guards changed; empty for the resource as a whole",
          "x-go-type-skip-optional-pointer": true
        },
        "Remove": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Guard keys removed",
          "x-go-type-skip-optional-pointer": true
        },
        "Set": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Guard keys added or changed, with their new values",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "MergeKeyValue": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true
        },
        "Value": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "MutationConflict": {
      "type": "object",
      "properties": {
        "Details": {
          "type": "string",
          "description": "Explanation the Reason alone cannot carry, such as the error text of a failed replay",
          "x-go-type-skip-optional-pointer": true
        },
        "Guard": {
          "allOf": [
            {
              "$ref": "#/$defs/WithheldGuard"
            }
          ],
          "description": "For Guarded: the guard the operation's clearance did not cover"
        },
        "GuardChange": {
          "allOf": [
            {
              "$ref": "#/$defs/GuardDelta"
            }
          ],
          "description": "For GuardWithheld: the guard change that did not propagate"
        },
        "Path": {
          "type": "string",
          "description": "Path of the mutation; empty for resource-level conflicts",
          "x-go-type-skip-optional-pointer": true
        },
        "Reason": {
          "type": "string",
          "description": "Why the mutation was dropped",
          "x-go-type-skip-optional-pointer": true
        },
        "Resource": {
          "allOf": [
            {
              "$ref": "#/$defs/ResourceInfo"
            }
          ],
          "description": "Resource the mutation applied to"
        },
        "Source": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationInfo"
            }
          ],
          "description": "The dropped source-side mutation"
        },
        "Target": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationInfo"
            }
          ],
          "description": "The target-side mutation that caused the drop, when applicable (Subtracted, DeleteShadowed)"
        },
        "UnitID": {
          "type": "string",
          "description": "ID of the other unit involved in the conflict (upstream for upgrade/merge, link target for resolve)",
          "format": "uuid",
          "x-go-type-skip-optional-pointer": true,
          "x-omitzero": true
        }
      }
    },
    "MutationConflictList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MutationConflict"
      }
    },
    "MutationInfo": {
      "type": "object",
      "properties": {
        "Index": {
          "type": "integer",
          "description": "Function index or sequence number corresponding to the change",
          "format": "int64",
          "x-go-type-skip-optional-pointer": true
        },
        "MutationType": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationType"
            }
          ],
          "description": "Type of mutation performed on the associated configuration element: Add, Update, Replace, Delete, or None, if no change"
        },
        "Patch": {
          "type": "string",
          "description": "Line-level patch for multi-line string updates, in unified diff format. When present on an Update, PatchMutations applies this to the target value instead of replacing with Value. Falls back to Value if the patch cannot be applied cleanly.",
          "x-go-type-skip-optional-pointer": true
        },
        "Protected": {
          "type": "boolean",
          "description": "True if this is a local override a merge must not overwrite; false if the value came from elsewhere and may be overwritten",
          "x-go-type-skip-optional-pointer": true
        },
        "Value": {
          "type": "string",
          "description": "Removed configuration data if MutationType is Delete and otherwise the new data",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "MutationMap": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/MutationInfo"
      }
    },
    "MutationType": {
      "enum": [
        "Add",
        "Delete",
        "Update",
        "Replace",
        "None"
      ],
      "type": "string"
    },
    "PathChange": {
      "type": "object",
      "properties": {
        "Attribution": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationInfo"
            }
          ],
          "description": "The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution"
        },
        "ChangeType": {
          "type": "string",
          "description": "Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context",
          "x-go-type-skip-optional-pointer": true
        },
        "Comment": {
          "type": "string",
          "description": "Head, Line, or Foot when the change is to a comment on the node at the path rather than to its value: the comment above the node, at the end of its line, or below it. The path of a comment on a whole resource is empty",
          "x-go-type-skip-optional-pointer": true
        },
        "DisplayPath": {
          "type": "string",
          "description": "The path in configuration path syntax, as --path arguments and where filters take it, with each unkeyed array element named by its index",
          "x-go-type-skip-optional-pointer": true
        },
        "FromDataType": {
          "type": "string",
          "description": "How to read FromValue: string, int, or bool for a scalar, YAML for a map or array, and empty for a scalar of another type, such as a float or null, or when the From side has no value",
          "x-go-type-skip-optional-pointer": true
        },
        "FromValue": {
          "type": "string",
          "description": "The value on the From side: a scalar's text, or a YAML block for a map or array",
          "x-go-type-skip-optional-pointer": true
        },
        "Patch": {
          "type": "string",
          "description": "A unified line diff, for multi-line string values",
          "x-go-type-skip-optional-pointer": true
        },
        "Path": {
          "type": "string",
          "description": "The path as MutationSources and patch functions record it",
          "x-go-type-skip-optional-pointer": true
        },
        "Segments": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/PathSegment"
          },
          "description": "The path split into its segments, for rendering without parsing the path syntax",
          "x-go-type-skip-optional-pointer": true
        },
        "ToDataType": {
          "type": "string",
          "description": "How to read ToValue: string, int, or bool for a scalar, YAML for a map or array, and empty for a scalar of another type, such as a float or null, or when the To side has no value",
          "x-go-type-skip-optional-pointer": true
        },
        "ToValue": {
          "type": "string",
          "description": "The value on the To side: a scalar's text, or a YAML block for a map or array. For an unchanged path, the value on both sides",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "PathSegment": {
      "required": [
        "FromIndex",
        "ToIndex"
      ],
      "type": "object",
      "properties": {
        "Field": {
          "type": "string",
          "description": "The map key, for a map segment",
          "x-go-type-skip-optional-pointer": true
        },
        "FromIndex": {
          "type": "integer",
          "description": "The element's index on the From side; -1 for a map key or an element absent there",
          "x-go-type-skip-optional-pointer": true
        },
        "MergeKeys": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MergeKeyValue"
          },
          "description": "The merge keys that identify the element, for an element of a merge-keyed array",
          "x-go-type-skip-optional-pointer": true
        },
        "ToIndex": {
          "type": "integer",
          "description": "The element's index on the To side; -1 for a map key or an element absent there",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "ResourceDiff": {
      "type": "object",
      "properties": {
        "Attribution": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationInfo"
            }
          ],
          "description": "For an Add, the To side's MutationSources entry for the resource, which says what added it; returned when include names Attribution"
        },
        "ChangeType": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationType"
            }
          ],
          "description": "Add, Delete, Update, or None when the resource is unchanged"
        },
        "Changes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PathChange"
          },
          "description": "Changes within the resource, for an Update, in document order",
          "x-go-type-skip-optional-pointer": true
        },
        "FromValue": {
          "type": "string",
          "description": "The whole resource, for a Delete",
          "x-go-type-skip-optional-pointer": true
        },
        "PreviousResource": {
          "allOf": [
            {
              "$ref": "#/$defs/ResourceInfo"
            }
          ],
          "description": "The resource on the From side, when it was matched across a rename"
        },
        "Resource": {
          "allOf": [
            {
              "$ref": "#/$defs/ResourceInfo"
            }
          ],
          "description": "Identifies the resource on the To side, or on the From side if it was deleted"
        },
        "ToValue": {
          "type": "string",
          "description": "The whole resource, for an Add",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "ResourceInfo": {
      "type": "object",
      "properties": {
        "ResourceCategory": {
          "type": "string",
          "description": "Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig",
          "x-go-type-skip-optional-pointer": true
        },
        "ResourceName": {
          "type": "string",
          "description": "Name of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form <metadata.namespace>/<metadata.name>; not all ToolchainTypes necessarily use '/' as a separator between any scope(s) and name or other client-chosen ID",
          "x-go-type-skip-optional-pointer": true
        },
        "ResourceNameStableCore": {
          "type": "string",
          "description": "Name of a resource in the system under management represented in the configuration data with generated prefixes and suffixes stripped; empty if nothing to strip",
          "x-go-type-skip-optional-pointer": true
        },
        "ResourceNameWithoutScope": {
          "type": "string",
          "description": "Name of a resource in the system under management represented in the configuration data, without any uniquifying scope, such as Namespace, Project, Account, Region, etc.; Kubernetes resources are represented in the form <metadata.name>",
          "x-go-type-skip-optional-pointer": true
        },
        "ResourceType": {
          "type": "string",
          "description": "Type of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form <apiVersion>/<kind> (aka group-version-kind)",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "ResourceMutation": {
      "type": "object",
      "properties": {
        "Aliases": {
          "type": "object",
          "additionalProperties": {
            "type": "object"
          },
          "description": "Names (with scopes, if any) used in current and prior revisions of this resource",
          "x-go-type-skip-optional-pointer": true
        },
        "AliasesWithoutScopes": {
          "type": "object",
          "additionalProperties": {
            "type": "object"
          },
          "description": "Names without scopes used in current and prior revisions of this resource",
          "x-go-type-skip-optional-pointer": true
        },
        "ArrayElementAliases": {
          "allOf": [
            {
              "$ref": "#/$defs/ArrayElementAliasMap"
            }
          ],
          "description": "For merge-keyed arrays in which an element was renamed (its merge-key value changed): the array parent path mapped to a previous-merge-key -> new-merge-key map. PatchMutations rewrites the matched element's merge-key field accordingly so child paths and ArrayOrders entries resolve under the new key."
        },
        "ArrayOrders": {
          "allOf": [
            {
              "$ref": "#/$defs/ArrayOrderMap"
            }
          ],
          "description": "For merge-keyed arrays whose element set or order changed in this mutation: the desired sequence of merge-key values in source order, keyed by the array's parent path. PatchMutations applies this as a reorder pass after path mutations so positional associative arrays (e.g., Kubernetes initContainers, env, ports) preserve source-side ordering rather than landing append-on-clash."
        },
        "PathMutationMap": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationMap"
            }
          ],
          "description": "Path-level mutation information; more deeply nested paths override values represented at higher levels"
        },
        "Resource": {
          "allOf": [
            {
              "$ref": "#/$defs/ResourceInfo"
            }
          ],
          "description": "Identifiers of the resource to which the mutations correspond"
        },
        "ResourceMutationInfo": {
          "allOf": [
            {
              "$ref": "#/$defs/MutationInfo"
            }
          ],
          "description": "Resource-level mutation information, such as for Add, Delete, or Replace"
        }
      }
    },
    "ResourceMutationList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ResourceMutation"
      }
    },
    "ResponseError": {
      "type": "object",
      "properties": {
        "Details": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Additional context messages",
          "x-go-type-skip-optional-pointer": true
        },
        "ErrorMetadata": {
          "allOf": [
            {
              "$ref": "#/$defs/ErrorMetadata"
            }
          ],
          "description": "Structured error details like field violations"
        },
        "Message": {
          "type": "string",
          "description": "The primary error message",
          "x-go-type-skip-optional-pointer": true
        },
        "Status": {
          "type": "integer",
          "description": "HTTP status code",
          "x-go-type-skip-optional-pointer": true
        },
        "Type": {
          "type": "string",
          "description": "The category of the error, as a code: UserInput, Validation, Data, Authentication, Permission, NotFound, Conflict, AlreadyExists, Unprocessable, Locked, PreconditionFailed, TooManyRequests, Unexpected, GatewayTimeout, or ServiceUnavailable",
          "x-go-type-skip-optional-pointer": true
        }
      }
    },
    "WithheldGuard": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The guard key the operation was not cleared for",
          "x-go-type-skip-optional-pointer": true
        },
        "Precondition": {
          "type": "boolean",
          "description": "True when the clearance forbade this key with DoesNotExist rather than simply not covering it",
          "x-go-type-skip-optional-pointer": true
        },
        "Value": {
          "type": "string",
          "description": "The guard value",
          "x-go-type-skip-optional-pointer": true
        }
      }
    }
  }
}

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/confighub-function-invocations-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.