Answers are generated based on the documentation.

Experimental

API version Product manual Download OpenAPI specification Markdown

Schema

KitFieldOutcome

Type: object

KitFieldOutcome identifies one non-applied declaration without exposing its value.

digest

Type: string

digest is the resolved content identity when resolution succeeded.

All schema constraints and annotations

{
  "description": "digest is the resolved content identity when resolution succeeded.",
  "type": "string"
}

disposition · required

Schema: KitFieldDisposition

disposition never claims that an accepted declaration has executed.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/KitFieldDisposition",
  "description": "disposition never claims that an accepted declaration has executed.",
  "not": {
    "enum": [
      "unspecified"
    ]
  }
}

fieldPath · required

Type: string

field_path is an RFC 6901 pointer into the pinned JSON artifact.

All schema constraints and annotations

{
  "description": "field_path is an RFC 6901 pointer into the pinned JSON artifact.",
  "type": "string"
}

kitIndex

Type: integer

kit_index is the zero-based position in the originating request's kits.

All schema constraints and annotations

{
  "description": "kit_index is the zero-based position in the originating request's kits.",
  "exclusiveMaximum": 64,
  "type": "integer"
}

reason · required

Schema: KitFieldReason

reason is a bounded category, not caller-controlled diagnostic content.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/KitFieldReason",
  "description": "reason is a bounded category, not caller-controlled diagnostic content.",
  "not": {
    "enum": [
      "unspecified"
    ]
  }
}

reasonText

Type: string

reason_text contains nonsecret explanatory text, never values or command content.

All schema constraints and annotations

{
  "description": "reason_text contains nonsecret explanatory text, never values or command content.",
  "type": "string"
}

ref · required

Type: string

ref preserves the exact requested kit reference.

All schema constraints and annotations

{
  "description": "ref preserves the exact requested kit reference.",
  "type": "string"
}

All schema constraints and annotations

{
  "description": "KitFieldOutcome identifies one non-applied declaration without exposing its value.",
  "properties": {
    "digest": {
      "description": "digest is the resolved content identity when resolution succeeded.",
      "type": "string"
    },
    "disposition": {
      "$ref": "#/components/schemas/KitFieldDisposition",
      "description": "disposition never claims that an accepted declaration has executed.",
      "not": {
        "enum": [
          "unspecified"
        ]
      }
    },
    "fieldPath": {
      "description": "field_path is an RFC 6901 pointer into the pinned JSON artifact.",
      "type": "string"
    },
    "kitIndex": {
      "description": "kit_index is the zero-based position in the originating request's kits.",
      "exclusiveMaximum": 64,
      "type": "integer"
    },
    "reason": {
      "$ref": "#/components/schemas/KitFieldReason",
      "description": "reason is a bounded category, not caller-controlled diagnostic content.",
      "not": {
        "enum": [
          "unspecified"
        ]
      }
    },
    "reasonText": {
      "description": "reason_text contains nonsecret explanatory text, never values or command content.",
      "type": "string"
    },
    "ref": {
      "description": "ref preserves the exact requested kit reference.",
      "type": "string"
    }
  },
  "required": [
    "ref",
    "fieldPath",
    "disposition",
    "reason"
  ],
  "title": "KitFieldOutcome",
  "type": "object"
}