Properties
| Name | Type | Description |
|---|---|---|
| ChangeOrderID | string | |
| Complete | boolean | Every Stage of the ChangeWorkflow already has the change; nothing was promoted. |
| DryRun | boolean | True when nothing was written. |
| Error | object | Set when the gates refused the promotion: why, with each failed gate's message among its Details. |
| Final | array | When Complete, the gates of the ChangeWorkflow's Final, evaluated over each Space of the last Stage. The ChangeOrder's Stage becomes Completed once they all hold. |
| Plan | string | Digest of the planned actions. Send it as ExpectedPlan to apply exactly this plan. |
| Spaces | array | In the order they were, or would be, promoted: a Space after any selected Space it takes from. |
| Stages | array | The Stages entered, each with every gate evaluated over the Stage before it. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/confighub/json-schema/confighub-promote-result-schema.json",
"title": "PromoteResult",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/confighub-promote-api-openapi.yml#/components/schemas/PromoteResult",
"type": "object",
"properties": {
"ChangeOrderID": {
"type": "string",
"format": "uuid"
},
"Complete": {
"type": "boolean",
"description": "Every Stage of the ChangeWorkflow already has the change; nothing was promoted.",
"x-go-type-skip-optional-pointer": true
},
"DryRun": {
"type": "boolean",
"description": "True when nothing was written.",
"x-go-type-skip-optional-pointer": true
},
"Error": {
"allOf": [
{
"$ref": "#/$defs/ResponseError"
}
],
"description": "Set when the gates refused the promotion: why, with each failed gate's message among its Details."
},
"Final": {
"type": "array",
"items": {
"$ref": "#/$defs/PromoteGateResult"
},
"description": "When Complete, the gates of the ChangeWorkflow's Final, evaluated over each Space of the last Stage. The ChangeOrder's Stage becomes Completed once they all hold.",
"x-go-type-skip-optional-pointer": true
},
"Plan": {
"type": "string",
"description": "Digest of the planned actions. Send it as ExpectedPlan to apply exactly this plan.",
"x-go-type-skip-optional-pointer": true
},
"Spaces": {
"type": "array",
"items": {
"$ref": "#/$defs/PromoteSpaceResult"
},
"description": "In the order they were, or would be, promoted: a Space after any selected Space it takes from.",
"x-go-type-skip-optional-pointer": true
},
"Stages": {
"type": "array",
"items": {
"$ref": "#/$defs/PromoteStageResult"
},
"description": "The Stages entered, each with every gate evaluated over the Stage before it.",
"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"
}
}
},
"AttestationGateCaller": {
"type": "object",
"properties": {
"AuthoredRevisions": {
"type": "integer",
"description": "How many of the Revisions evaluated the caller wrote part of.",
"x-go-type-skip-optional-pointer": true
},
"Counts": {
"type": "boolean",
"description": "A Pass the caller records would count on every Revision evaluated.",
"x-go-type-skip-optional-pointer": true
},
"Reason": {
"type": "string",
"description": "Why it would not: NotEligible, when the prerequisite names neither the caller nor a Group of theirs, or Author, when the caller wrote part of the change on some Revision.",
"x-go-type-skip-optional-pointer": true
}
}
},
"AttestationGateEntry": {
"type": "object",
"properties": {
"AttestationID": {
"type": "string",
"format": "uuid",
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"CountedOn": {
"type": "integer",
"description": "How many of the Revisions evaluated it counts on. A Fail that counts rejects them.",
"x-go-type-skip-optional-pointer": true
},
"CreatedAt": {
"type": "string",
"format": "date-time",
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"Reason": {
"type": "string",
"description": "Why it counts on none of the Revisions it covers: Revoked, Expired, TooOld (older than MaxAge), NotEligible, Author, or FailIgnored (a Fail, under IgnoreFail).",
"x-go-type-skip-optional-pointer": true
},
"Result": {
"type": "string",
"description": "Pass or Fail.",
"x-go-type-skip-optional-pointer": true
},
"UserID": {
"type": "string",
"format": "uuid",
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"ValidUntil": {
"type": [
"string",
"null"
],
"description": "When it stops counting: the earlier of its ExpiresAt and its CreatedAt plus the prerequisite's MaxAge. Absent when neither is set.",
"format": "date-time",
"x-go-type-skip-optional-pointer": true
}
}
},
"AttestationGateResult": {
"type": "object",
"properties": {
"Attestations": {
"type": "array",
"items": {
"$ref": "#/$defs/AttestationGateEntry"
},
"description": "Every Attestation of Type covering a Revision evaluated, directly or carried forward from an earlier Revision of the same Unit with the same DataHash, and what became of it.",
"x-go-type-skip-optional-pointer": true
},
"AuthorUserIDs": {
"type": "array",
"items": {
"$ref": "#/$defs/UUID"
},
"description": "Users excluded from counting on some Revision because they wrote part of the change there. Empty with AllowAuthors.",
"x-go-type-skip-optional-pointer": true
},
"Caller": {
"allOf": [
{
"$ref": "#/$defs/AttestationGateCaller"
}
],
"description": "Whether a Pass recorded by the caller would count here."
},
"Counted": {
"type": "integer",
"description": "The fewest attesters counted on any Revision evaluated: the gate's progress toward Required.",
"x-go-type-skip-optional-pointer": true
},
"Required": {
"type": "integer",
"description": "How many distinct attesters each Revision needs: Count, or the number of FromGroupIDs with DistinctGroups.",
"x-go-type-skip-optional-pointer": true
},
"Revisions": {
"type": "integer",
"description": "How many Revisions were evaluated: one of each Unit the change changed in the Space, or each Revision a Release bundles.",
"x-go-type-skip-optional-pointer": true
},
"SatisfiedRevisions": {
"type": "integer",
"description": "How many of them have what the prerequisite asks for.",
"x-go-type-skip-optional-pointer": true
},
"Truncated": {
"type": "boolean",
"description": "More Revisions fall short than Unsatisfied lists.",
"x-go-type-skip-optional-pointer": true
},
"Type": {
"type": "string",
"description": "The Attestation Type the prerequisite counts.",
"x-go-type-skip-optional-pointer": true
},
"Unsatisfied": {
"type": "array",
"items": {
"$ref": "#/$defs/AttestationGateRevision"
},
"description": "The Revisions that fall short, at most 100.",
"x-go-type-skip-optional-pointer": true
}
}
},
"AttestationGateRevision": {
"type": "object",
"properties": {
"AuthorUserIDs": {
"type": "array",
"items": {
"$ref": "#/$defs/UUID"
},
"description": "Users excluded from counting on this Revision because they wrote part of the change on this Unit. Empty with AllowAuthors.",
"x-go-type-skip-optional-pointer": true
},
"Counted": {
"type": "integer",
"description": "Distinct attesters counted on this Revision.",
"x-go-type-skip-optional-pointer": true
},
"Reason": {
"type": "string",
"description": "AttestationsMissing or AttestationRejected.",
"x-go-type-skip-optional-pointer": true
},
"RevisionNum": {
"type": "integer",
"format": "int64",
"x-go-type-skip-optional-pointer": true
},
"UnitID": {
"type": "string",
"format": "uuid",
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"UnitSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
}
}
},
"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
}
}
},
"PromoteGateResult": {
"type": "object",
"properties": {
"Attestation": {
"allOf": [
{
"$ref": "#/$defs/AttestationGateResult"
}
],
"description": "For an attestation prerequisite, what was counted, whether or not the gate holds."
},
"Message": {
"type": "string",
"description": "Why the gate does not hold.",
"x-go-type-skip-optional-pointer": true
},
"Prerequisite": {
"type": "string",
"description": "Promoted, Validated, Released, Healthy, or the name of a custom or attestation prerequisite.",
"x-go-type-skip-optional-pointer": true
},
"Reason": {
"type": "string",
"description": "Why the gate does not hold, as a code: NotPromoted, PreviousStageEmpty, NotReleased, ValidationErrors, NotMarked, NoReleaseTarget, NoRelease, NoLiveStatus, NotSynced, Deploying, DeployFailed, Unhealthy, AttestationsMissing, AttestationRejected, ExpressionFalse, EvaluationFailed, or UnknownPrerequisite. A client that does not know a code shows Message.",
"x-go-type-skip-optional-pointer": true
},
"Satisfied": {
"type": "boolean",
"x-go-type-skip-optional-pointer": true
},
"SpaceID": {
"type": "string",
"format": "uuid",
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"SpaceSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
}
}
},
"PromoteLinkResult": {
"type": "object",
"properties": {
"Action": {
"type": "string",
"description": "Create, Unchanged, Skip, or Orphaned.",
"x-go-type-skip-optional-pointer": true
},
"Error": {
"$ref": "#/$defs/ResponseError"
},
"FromUnitSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"LinkID": {
"type": "string",
"description": "Absent for a Link a dry run would create.",
"format": "uuid"
},
"Message": {
"type": "string",
"description": "Why the Link was skipped or orphaned, in words.",
"x-go-type-skip-optional-pointer": true
},
"Reason": {
"type": "string",
"description": "Adopted for an Unchanged Link, TargetUnitMissing for a Skip, or UpstreamLinkDeleted for an Orphaned one.",
"x-go-type-skip-optional-pointer": true
},
"Slug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"ToSpaceSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"ToUnitSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"UpstreamLinkID": {
"type": "string",
"format": "uuid"
}
}
},
"PromoteSpaceResult": {
"type": "object",
"properties": {
"Action": {
"type": "string",
"description": "Promote, Unchanged, Skipped, Blocked, or Failed.",
"x-go-type-skip-optional-pointer": true
},
"Error": {
"$ref": "#/$defs/ResponseError"
},
"Links": {
"type": "array",
"items": {
"$ref": "#/$defs/PromoteLinkResult"
},
"x-go-type-skip-optional-pointer": true
},
"Message": {
"type": "string",
"description": "Why the Space was Skipped or Blocked, in words.",
"x-go-type-skip-optional-pointer": true
},
"PreviewedAgainstCurrentUpstream": {
"type": "boolean",
"description": "A dry run previewed this Space against its upstream as it is now, although the same request promotes that upstream first.",
"x-go-type-skip-optional-pointer": true
},
"Reason": {
"type": "string",
"description": "Why the Space was Skipped or Blocked, as a code: ChangeOrderSpace, NotInScope, UpstreamPromotedFirst, or UpstreamFailed.",
"x-go-type-skip-optional-pointer": true
},
"SpaceID": {
"type": "string",
"format": "uuid",
"x-go-type-skip-optional-pointer": true,
"x-omitzero": true
},
"SpaceSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"Stage": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"Units": {
"type": "array",
"items": {
"$ref": "#/$defs/PromoteUnitResult"
},
"x-go-type-skip-optional-pointer": true
},
"UpstreamSpaceID": {
"type": "string",
"format": "uuid"
},
"UpstreamSpaceSlug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
}
}
},
"PromoteStageResult": {
"type": "object",
"properties": {
"Chosen": {
"type": "boolean",
"description": "The Stage was the next one the change has not reached, rather than named.",
"x-go-type-skip-optional-pointer": true
},
"Forced": {
"type": "boolean",
"description": "The gates did not hold and the promotion was forced.",
"x-go-type-skip-optional-pointer": true
},
"Gates": {
"type": "array",
"items": {
"$ref": "#/$defs/PromoteGateResult"
},
"x-go-type-skip-optional-pointer": true
},
"Name": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"PreviousStage": {
"type": "string",
"description": "The Stage whose Spaces the gates are evaluated over. Empty for the first Stage, whose gates are evaluated over the change order's own Space.",
"x-go-type-skip-optional-pointer": true
}
}
},
"PromoteUnitResult": {
"type": "object",
"properties": {
"Action": {
"type": "string",
"description": "Upgrade, Resolve, Mark, Empty, Revive, Clone, Invoke, Unchanged, or Skip.",
"x-go-type-skip-optional-pointer": true
},
"ConfigData": {
"type": "string",
"description": "The configuration the write produced, or on a dry run would produce. Returned when include names ConfigData, for a Unit the promotion writes.",
"x-go-type-skip-optional-pointer": true
},
"Conflicts": {
"allOf": [
{
"$ref": "#/$defs/MutationConflictList"
}
],
"description": "Paths withheld because they were overridden locally or guarded."
},
"Diff": {
"allOf": [
{
"$ref": "#/$defs/ConfigDiff"
}
],
"description": "The same change path by path, with the values on both sides. Returned when include names Diff."
},
"Error": {
"$ref": "#/$defs/ResponseError"
},
"HeadRevisionNum": {
"type": "integer",
"format": "int64",
"x-go-type-skip-optional-pointer": true
},
"LinkIDs": {
"type": "array",
"items": {
"$ref": "#/$defs/UUID"
},
"description": "For a Resolve, and a Mark made by one, the Links resolved.",
"x-go-type-skip-optional-pointer": true
},
"Mutations": {
"allOf": [
{
"$ref": "#/$defs/ResourceMutationList"
}
],
"description": "What the write changed, or on a dry run would change: the entries of the Unit's MutationSources it produced. Returned when include names Mutations."
},
"PreviousHeadMutationNum": {
"type": "integer",
"format": "int64",
"x-go-type-skip-optional-pointer": true
},
"PreviousHeadRevisionNum": {
"type": "integer",
"format": "int64",
"x-go-type-skip-optional-pointer": true
},
"Reason": {
"type": "string",
"description": "For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken, NotChanged when the change does not change the Unit, or CreatedInSpace when the Unit was created in this Space rather than cloned into it. A Unit in the Space that the change does not change is marked once the Space's writes are done, with both Tags on the Revision the ChangeOrder's PriorRevisions names. For an applied Upgrade or Resolve: NoChange, when the Unit already held the change, so no Revision was made and the ChangeOrder's Tags mark its head.",
"x-go-type-skip-optional-pointer": true
},
"Slug": {
"type": "string",
"x-go-type-skip-optional-pointer": true
},
"UnitID": {
"type": "string",
"description": "Absent for a clone a dry run would create.",
"format": "uuid"
},
"UpstreamUnitID": {
"type": "string",
"description": "Absent for a Unit created in this Space, and for a Resolve over Links to more than one Unit.",
"format": "uuid"
}
}
},
"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 syst
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://artifacts.apis.io/confighub/json-schema/confighub-promote-result-schema.json
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/confighub-promote-result"
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.