From a9b7a9a5d2d5afc395b3b608b4a3d5be2cf96644 Mon Sep 17 00:00:00 2001
From: Chuang Wang <chuangw@google.com>
Date: Fri, 16 Sep 2022 12:46:43 -0700
Subject: [PATCH] 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 <chuangw@google.com>
---
 docs/api-spec.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

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: <br>- `"string"` (default) <br>- `"array"` | REQUIRED |
+| `type`      | Enum:<br>- `"string"` (default)<br>- `"array"` <br>- `"object"` | REQUIRED for `string` and `array`type <br> RECOMMENDED `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`