Update API spec doc to reflect the new fields introduced from TEP75&76

Implementation of TEP75&76 supported object type param, object type result and array type result, which introduced some changes to the API spec i.e. `ParamSpec`, `TaskResult` and `TaskRunResult`. This PR updates the doc to reflect the changes. Signed-off-by: Chuang Wang <[email protected]>
tektoncd · Sep 19, 2022 · d7e80a3 · d7e80a3
1 parent 34274fb
commit d7e80a3
Showing 1 changed file with 6 additions and 2 deletions.
diff --git 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: <br>- `"string"` (default) <br>- `"array"` | REQUIRED |
+| `type`      | Enum:<br>- `"string"` (default)<br>- `"array"` <br>- `"object"` | REQUIRED for `string` and `array`type <br> RECOMMENDED for `object` type |
+| `properties`  | map<string,PropertySpec> |RECOMMENDED <br><br>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:<br>- `"string"` (default)<br>- `"array"` <br>- `"object"` | REQUIRED for `string` type <br> RECOMMENDED for `array` and `object` |
+| `properties`  | map<string,PropertySpec> | RECOMMENDED <br><br>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:<br>- `"string"` (default)<br>- `"array"` <br>- `"object"` | REQUIRED for `string` type <br> RECOMMENDED for `array` and `object` |
+| `value`    | `ParamValue`     | REQUIRED    |
 
 ### `TaskSpec`