diff --git a/docs/api-spec.md b/docs/api-spec.md index 0a2814bda08..504c71faedb 100644 --- a/docs/api-spec.md +++ b/docs/api-spec.md @@ -244,7 +244,8 @@ List responses have the following fields (based on [`meta.v1/ListMeta`](https:// |---------------|------------|-------------| | `name` | string | REQUIRED | | `description` | string | REQUIRED | -| `type` | Enum:
- `"string"` (default)
- `"array"` | REQUIRED | +| `type` | Enum:
- `"string"` (default)
- `"array"`
- `"object"` | REQUIRED for `string` and `array`type
RECOMMENDED `object` type | +| `properties` | map |RECOMMENDED

note: `PropertySpec` is a type that defines the spec of an individual key. See how to define the `properties` section in the [example](../examples/v1beta1/taskruns/alpha/object-param-result.yaml).| | `default` | `ParamValue` | REQUIRED | ### `Step` @@ -279,13 +280,16 @@ List responses have the following fields (based on [`meta.v1/ListMeta`](https:// |--------------|------------|-------------| | `name` | string | REQUIRED | | `description` | string | REQUIRED | +| `type` | Enum:
- `"string"` (default)
- `"array"`
- `"object"` | REQUIRED for `string` type
RECOMMENDED for `array` and `object` | +| `properties` | map | RECOMMENDED

note: `PropertySpec` is a type that defines the spec of an individual key. See how to define the `properties` section in the [example](../examples/v1beta1/taskruns/alpha/object-param-result.yaml).| ### `TaskRunResult` | Field Name | Field Type | Requirement | |------------|------------|-------------| | `name` | string | REQUIRED | -| `value` | string | REQUIRED | +| `type` | Enum:
- `"string"` (default)
- `"array"`
- `"object"` | REQUIRED for `string` type
RECOMMENDED for `array` and `object` | +| `value` | `ParamValue` | REQUIRED | ### `TaskSpec`