diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index baf641051..5e5d31c36 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -189,7 +189,11 @@ is because we do not have health checking set up yet. Please refer - - Results can be read across parents by specifying `-` as the `parent`. - This is useful for listing all results stored in the system without - prior knowledge about the available parents. + content: + application/json: + schema: + $ref: "#/components/schemas/Log" + description: "" + x-last-modified: 1677676553132 + operationId: get_log_by_name + summary: Get a Log given the name + description: "" + delete: + tags: + - Logs + responses: + "200": + content: + application/json: + schema: + description: "" + required: [] + type: object + externalDocs: + description: "" + url: "" + example: "" + example: "" + description: "" + x-last-modified: 1677760513398 + operationId: delete_log_by_name + summary: Delete a log given the name parameters: - - $ref: "#/components/parameters/parent" - name: parent - x-last-modified: 1677826043887 - - $ref: "#/components/parameters/filter" - name: filter - x-last-modified: 1679484691871 + - $ref: "#/components/parameters/log-name" - $ref: "#/components/parameters/page_token" - name: page_token - x-last-modified: 1679484706871 - $ref: "#/components/parameters/page_size" - name: page_size - x-last-modified: 1679484719471 + - $ref: "#/components/parameters/filter" - $ref: "#/components/parameters/order_by" - name: order_by - x-last-modified: 1679484733009 - x-last-modified: 1677671948697 - /v1alpha2/parents/{parent}/results/{result_uid}/records/{record_uid}: - summary: Create, delete or update records + x-last-modified: 1691401424373 + /v1alpha2/parents/{record-name}: + summary: Get, Create, Delete or Update record + description: >- + Record name of the format + `{parent}/results/{result-uid}/records/{record-uid}` get: tags: - Records @@ -95,8 +108,8 @@ paths: schema: $ref: "#/components/schemas/Record" description: Default response - operationId: get_record_by_uid - summary: Get a record given uid + operationId: get_record_by_name + summary: Get a record given name description: "" post: requestBody: @@ -115,8 +128,8 @@ paths: schema: $ref: "#/components/schemas/Record" description: Default response - operationId: create_record_by_uid - summary: Create record with given uid + operationId: create_record_by_name + summary: Create record with given name description: "" delete: tags: @@ -132,8 +145,8 @@ paths: example: "" description: "" x-last-modified: 1677760439227 - operationId: delete_record_by_uid - summary: Delete record given the uid + operationId: delete_record_by_name + summary: Delete record given the name description: "" patch: requestBody: @@ -152,22 +165,18 @@ paths: schema: $ref: "#/components/schemas/Record" description: Default response - operationId: "" - summary: Update a record given the uid + operationId: update_record_by_name + summary: Update a record given the name description: "" parameters: - - $ref: "#/components/parameters/parent" - name: parent - x-last-modified: 1677672324160 - - $ref: "#/components/parameters/result_uid" - name: result_uid - x-last-modified: 1677672338019 - - $ref: "#/components/parameters/record_uid" - name: record_uid - x-last-modified: 1677672352453 - x-last-modified: 1677672432307 - /v1alpha2/parents/{parent}/results/{result_uid}: - summary: Get, Create, Delete or update result + - $ref: "#/components/parameters/record-name" + - $ref: "#/components/parameters/page_token" + - $ref: "#/components/parameters/page_size" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/order_by" + x-last-modified: 1691482780140 + /v1alpha2/parents/{result-name}: + summary: Get, Create, Delete or Update Result get: tags: - Results @@ -178,8 +187,8 @@ paths: schema: $ref: "#/components/schemas/Result" description: Default response - operationId: get_result_by_uid - summary: Get a single result given the UID + operationId: get_result_by_name + summary: Get a single result given the name description: "" post: requestBody: @@ -198,8 +207,8 @@ paths: schema: $ref: "#/components/schemas/Result" description: Default response - operationId: create_result_by_uid - summary: Create a Result given data and UID + operationId: create_result_by_name + summary: Create a Result given data and name description: "" delete: tags: @@ -212,8 +221,8 @@ paths: $ref: "#/components/schemas/Result" example: "" description: Default response - operationId: delete_result_by_uid - summary: Delete a particular result using UID + operationId: delete_result_by_name + summary: Delete a particular result using name description: "" patch: requestBody: @@ -232,131 +241,81 @@ paths: schema: $ref: "#/components/schemas/Result" description: Default response - operationId: update_result_by_uid - summary: Update result given the UID + operationId: update_result_by_name + summary: Update result given the name description: "" parameters: - - $ref: "#/components/parameters/parent" - name: parent - x-last-modified: 1677672496911 - - $ref: "#/components/parameters/result_uid" - name: result_uid - x-last-modified: 1677672511792 - x-last-modified: 1677672484697 - /v1alpha2/parents/{parent}/results/{result_uid}/logs: - summary: List logs associated with a result + - $ref: "#/components/parameters/result-name" + - $ref: "#/components/parameters/page_token" + - $ref: "#/components/parameters/page_size" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/order_by" + x-last-modified: 1691482802206 + /v1alpha2/parents/{result-name}/logs: + summary: List logs associated with a Result get: tags: - Logs responses: "200": $ref: "#/components/responses/RecordsList" - x-last-modified: 1677673949442 - operationId: list_logs_by_result_uid - summary: List Logs given the Result UID + operationId: list_logs_by_result_name + summary: List Logs given the Result name description: >- Logs can be read across Results by specifying `-` as the `result_uid` or across parents by specifying `-` as the `parent`. (e.g., **default/results/-** or **-/results/-**). This can be used to read and filter matching Logs without knowing the exact Result name. parameters: - - $ref: "#/components/parameters/parent" - name: parent - x-last-modified: 1677672653795 - - $ref: "#/components/parameters/result_uid" - name: result_uid - x-last-modified: 1677672667367 + - $ref: "#/components/parameters/result-name" - $ref: "#/components/parameters/filter" - name: filter - x-last-modified: 1679485318262 - $ref: "#/components/parameters/page_size" - name: page_size - x-last-modified: 1679485331528 - $ref: "#/components/parameters/page_token" - name: page_token - x-last-modified: 1679485343811 - $ref: "#/components/parameters/order_by" - name: order_by - x-last-modified: 1679485356281 - x-last-modified: 1677672632222 - /v1alpha2/parents/{parent}/results/{result_uid}/logs/{log_uid}: - summary: Get or Delete Logs + x-last-modified: 1691482815378 + /v1alpha2/parents/{parent}/results: + summary: List Results associated with a Parent get: tags: - - Logs - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Log" - description: "" - x-last-modified: 1677676553132 - operationId: get_log_by_uid - summary: Get a Log given UID - delete: - tags: - - Logs + - Results responses: "200": - content: - application/json: - schema: - description: "" - type: object - example: "" - example: "" - description: "" - x-last-modified: 1677760513398 - operationId: delete_log_by_uid - summary: Delete a log given the UID + $ref: "#/components/responses/ResultsList" + operationId: list_results_by_parent_name + summary: Get the list of the Results given the parent name + description: >- + Results can be read across parents by specifying `-` as the `parent`. + This is useful for listing all results stored in the system without + prior knowledge about the available parents. parameters: - $ref: "#/components/parameters/parent" - name: parent - x-last-modified: 1677672795198 - - $ref: "#/components/parameters/result_uid" - name: result_uid - x-last-modified: 1677672810563 - - $ref: "#/components/parameters/log_uid" - name: log_uid - x-last-modified: 1677672825675 - x-last-modified: 1677774010236 - /v1alpha2/parents/{parent}/results/{result_uid}/records: - summary: "Get list of records associated with a result " + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/page_token" + - $ref: "#/components/parameters/page_size" + - $ref: "#/components/parameters/order_by" + x-last-modified: 1691482834608 + /v1alpha2/parents/{result-name}/records: + summary: "List Records associated with a Result " get: tags: - Records responses: "200": $ref: "#/components/responses/RecordsList" - x-last-modified: 1677828297346 - operationId: get_records_by_results_uid - summary: Get list of records + operationId: get_records_by_results_name + summary: Get list of records given the Result name description: >- Records can be read across Results by specifying `-` as the `result_uid` or across parents by specifying `-` as the `parent` . (e.g., **default/results/-** or **-/results/-**). This can be used to read and filter matching Records without knowing the exact Result name. parameters: - - $ref: "#/components/parameters/parent" - name: parent - x-last-modified: 1677828269940 - - $ref: "#/components/parameters/result_uid" - name: result_uid - x-last-modified: 1677828284019 + - $ref: "#/components/parameters/result-name" - $ref: "#/components/parameters/filter" - name: filter - x-last-modified: 1679484834694 - $ref: "#/components/parameters/order_by" - name: order_by - x-last-modified: 1679485370769 - $ref: "#/components/parameters/page_size" - name: page_size - x-last-modified: 1679485384718 - $ref: "#/components/parameters/page_token" - name: page_token - x-last-modified: 1679485400765 - x-last-modified: 1677828254610 + x-last-modified: 1691482861017 components: schemas: RecordType: @@ -419,8 +378,8 @@ components: RecordSummary: description: >- RecordSummary is a high level overview of a Record, typically - representing a "root" record for a result. It includes type agonstic - information so that UI's and other tools do not need to be aware of + representing a "root" record for a result. It includes type agnostic + information so that UI and other tools do not need to be aware of underlying types. required: - record @@ -449,12 +408,12 @@ components: type: string annotations: description: >- - Key-value pairs representing abitrary underlying record data that + Key-value pairs representing arbitrary underlying record data that clients want to include that aren't covered by the above fields. type: object x-last-modified: 1677769046145 Any: - description: Any represents lossely typed data to be stored within a Record. + description: Any represents loosely typed data to be stored within a Record. required: - value - type @@ -467,7 +426,6 @@ components: example: VGhpcyBpcyBhbiBleG1hcGxlIG9mIHJlY29yZCBkYXRhCg== type: $ref: "#/components/schemas/RecordType" - type: object x-last-modified: 1677769074438 Record: description: >- @@ -543,10 +501,6 @@ components: example: default/results/2be47d31-4d7f-4762-9616-969f2d7d9cc3 summary: $ref: "#/components/schemas/RecordSummary" - description: >- - High level overview of the root record for the Result. This is - provided as a convinence for clients to query Record state without - needing to make multiple calls to fetch the underlying Records. createdTime: deprecated: true format: date-time @@ -632,84 +586,92 @@ components: name: page_size description: >- Number of response to fetch in one request. This query can be used for - pagination. + pagination. The default value is 50. schema: type: integer in: query required: false allowEmptyValue: false - x-last-modified: 1679485107020 - log_uid: + x-last-modified: 1691479441591 + filter: deprecated: false - name: log_uid - description: It is an alias to the record uid denoting a log. + name: filter + description: "This query can be used to pass CEL Expressions to filter the response. " schema: - format: uuid type: string - in: path - required: true - x-last-modified: 1679485114681 - record_uid: + externalDocs: + url: https://github.com/tektoncd/results/tree/main/docs/api#filtering + in: query + required: false + allowEmptyValue: false + x-last-modified: 1691479470943 + record-name: deprecated: false - name: record_uid - description: Record UID is the server assigned identifier of the Record. + example: >- + default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/records/640d1af3-9c75-4167-8167-4d8e4f39d403 + name: name + description: >- + Record's name is of the format + `{parent-name}/results/{result-uid}/records/{record-uid}` schema: - format: uuid + pattern: >- + [A-Za-z0-9]+/results/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/records/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12} type: string in: path required: true - x-last-modified: 1679485126722 - result_uid: + x-last-modified: 1691482901851 + order_by: deprecated: false - name: result_uid - description: Result UID is the server assigned identifier of the result. + name: order_by + description: "This query can be used to order the response based on parameters. " schema: - format: uuid + enum: + - create_by asc + - create_by dsc + - update_by asc + - update_by dsc type: string - in: path - required: true - x-last-modified: 1679485137131 - parent: + externalDocs: + url: https://github.com/tektoncd/results/tree/main/docs/api#ordering + in: query + required: false + allowEmptyValue: false + x-last-modified: 1691482923349 + result-name: deprecated: false - name: parent - description: Parent name refers to the namespace name or workspace name. + example: default/results/640d1af3-9c75-4167-8167-4d8e4f39d403 + name: name + description: Result's name is of the format `{parent-name}/results/{results-uid}` schema: + pattern: " [A-Za-z0-9]+/results/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" type: string in: path required: true - x-last-modified: 1679485145042 - filter: + x-last-modified: 1691482940105 + log-name: deprecated: false - name: filter + example: >- + default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/logs/640d1af3-9c75-4167-8167-4d8e4f39d403 + name: name description: >- - This query can be used to pass CEL Expressions to filter the response. - See more details - [here](https://github.com/tektoncd/results/tree/main/docs/api#filtering). + Log's name is of the format + `{parent-name}/results/{results-uid}/logs/{log-uid}` schema: + pattern: >- + [A-Za-z0-9]+/results/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/logs/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12} type: string - externalDocs: - url: https://github.com/tektoncd/results/tree/main/docs/api#filtering - in: query - required: false - allowEmptyValue: false - x-last-modified: 1679485842876 - order_by: + in: path + required: true + x-last-modified: 1691482961354 + parent: deprecated: false - name: order_by - description: >- - This query can be used to order the response based on parameters. More - details can be found - [here](https://github.com/tektoncd/results/tree/main/docs/api#ordering). - Note: Add `%20` instead of space when adding an optional direction - qualifier, e.g `created_by%20asc`. + name: parent + description: Parent name refers to the namespace name or workspace name. schema: type: string - externalDocs: - url: https://github.com/tektoncd/results/tree/main/docs/api#ordering - in: query - required: false - allowEmptyValue: false - x-last-modified: 1679489217285 + in: path + required: true + x-last-modified: 1691482975806 securitySchemes: BasicAuth: scheme: bearer @@ -733,7 +695,7 @@ tags: url: https://github.com/tektoncd/results#data-model x-last-modified: 1677767456366 - name: Logs - description: "Logs is a type of Record. " + description: "Logs is a type of Record." x-last-modified: 1677767481655 - name: Results description: > @@ -741,7 +703,6 @@ tags: Records as a single entity. For example, you might have a single Result that groups the following Records: - * Source Event (e.g. pull request, push) that kicked off the action. * The PipelineRun that occurred. diff --git a/docs/api/rest-api-spec.md b/docs/api/rest-api-spec.md deleted file mode 100644 index c5c483fa3..000000000 --- a/docs/api/rest-api-spec.md +++ /dev/null @@ -1,462 +0,0 @@ -# Tekton Results REST API Specification - -**NOTE:** This documentation is only for refernce, please use [Swaggar UI](https://petstore.swagger.io/) (or similar services) with link to the [openapi spec](openapi.yaml) to see complete information. - -## Version: v1alpha2 - -[See Results API Documentation](https://github.com/tektoncd/results/tree/main/docs/api) - -### `/v1alpha2/parents/{parent}/results` - -#### GET - -##### Summary - -Get the list of the Results - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Results List](#results-list-response) | - ---- - -### `/v1alpha2/parents/{parent}/results/{result_uid}/records/{record_uid}` - -#### GET - -##### Summary - -Get a record given the uid - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | -| record_uid | Yes | [record_uid](#record_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Record](#record-response) | - -#### POST - -##### Summary - -Create a record with given uid - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | -| record_uid | Yes | [record_uid](#record_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Record](#record-response) | - -#### DELETE - -##### Summary - -Delete a record given the uid - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | -| record_uid | Yes | [record_uid](#record_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | {} | - -#### PATCH - -##### Summary - -Update a record with given uid - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | -| record_uid | Yes | [record_uid](#record_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Record](#record-response) | - ---- - -### `/v1alpha2/parents/{parent}/results/{result_uid}` - -#### GET - -##### Summary - -Get a single result given the UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Result](#result-response) | - -#### POST - -##### Summary - -Create a Result given data and UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Result](#result-response) | - -#### DELETE - -##### Summary - -Delete a particular result using UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | {} | - -#### PATCH - -##### Summary - -Update result given the UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Result](#result-response) | - ---- - -### `/v1alpha2/parents/{parent}/results/{result_uid}/logs` - -#### GET - -##### Summary - -List Logs given the Result UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Logs List](#records-list-response) | - ---- - -### `/v1alpha2/parents/{parent}/results/{result_uid}/logs/{log_uid}` - -#### GET - -##### Summary - -Get a Log given UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | -| log_uid | Yes | [log_uid](#log_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Log](#record-response) | - -#### DELETE - -##### Summary - -Delete a log given the UID - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | -| log_uid | Yes | [log_uid](#log_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | {} | - ---- - -### `/v1alpha2/parents/{parent}/results/{result_uid}/records` - -#### GET - -##### Summary - -Get list of records - -##### Parameters - -| Name | Required | Schema | -| ---- | -------- | ---- | -| parent | Yes | [parent](#parent) | -| result_uid | Yes | [result_uid](#result_uid) | - -##### Responses - -| Code | Description | -| ---- | ----------- | -| 200 | [Records List](#records-list-response) | - -## Parameters Description - -### parent - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | path | Parent name refers to the namespace name or workspace name. | - -### result_uid - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | path | Result UID is the server assigned identifier of the result. | - -### record_uid - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | path | Record UID is the server assigned identifier of the Record. | - -### logs_uid - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | path | It is an alias to the record uid denoting a log. | - -### filter - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | query | Add a CEL Expression Filter. See [here](README.md#filtering) for reference. | - -### page_size - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| integer | query | This query can be used for pagination. | - -### page_token - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | query | This can be used to fetch a particular page when response are paginated. | - -### order_by - -| Type | Located in | Description | -| ---- | ---------- | ----------- | -| string | query | This query can be used to order the response based on `created_on` or `updated_on`. See [here](README.md#ordering) for reference. | - -## Responses Example - -### Result Response - -```json -{ - "name": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403", - "id": "338481c9-3bc6-472f-9d1b-0f7705e6cb8c", - "uid": "338481c9-3bc6-472f-9d1b-0f7705e6cb8c", - "createdTime": "2023-03-02T07:26:48.972907Z", - "createTime": "2023-03-02T07:26:48.972907Z", - "updatedTime": "2023-03-02T07:26:54.191114Z", - "updateTime": "2023-03-02T07:26:54.191114Z", - "annotations": {}, - "etag": "338481c9-3bc6-472f-9d1b-0f7705e6cb8c-1677742014191114634", - "summary": { - "record": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/records/640d1af3-9c75-4167-8167-4d8e4f39d403", - "type": "tekton.dev/v1beta1.TaskRun", - "startTime": null, - "endTime": "2023-03-02T07:26:54Z", - "status": "SUCCESS", - "annotations": {} - } -} -``` - -### Results List Response - -```json -{ - "results": [ - { - "name": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403", - "id": "338481c9-3bc6-472f-9d1b-0f7705e6cb8c", - "uid": "338481c9-3bc6-472f-9d1b-0f7705e6cb8c", - "createdTime": "2023-03-02T07:26:48.972907Z", - "createTime": "2023-03-02T07:26:48.972907Z", - "updatedTime": "2023-03-02T07:26:54.191114Z", - "updateTime": "2023-03-02T07:26:54.191114Z", - "annotations": {}, - "etag": "338481c9-3bc6-472f-9d1b-0f7705e6cb8c-1677742014191114634", - "summary": { - "record": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/records/640d1af3-9c75-4167-8167-4d8e4f39d403", - "type": "tekton.dev/v1beta1.TaskRun", - "startTime": null, - "endTime": "2023-03-02T07:26:54Z", - "status": "SUCCESS", - "annotations": {} - } - }, - { - "name": "default/results/c360def0-d77e-4a3f-a1b0-5b0753e7d5af", - "id": "9514f318-9329-485b-871c-77a4a6904891", - "uid": "9514f318-9329-485b-871c-77a4a6904891", - "createdTime": "2023-03-02T07:28:05.535047Z", - "createTime": "2023-03-02T07:28:05.535047Z", - "updatedTime": "2023-03-02T07:28:10.308632Z", - "updateTime": "2023-03-02T07:28:10.308632Z", - "annotations": {}, - "etag": "9514f318-9329-485b-871c-77a4a6904891-1677742090308632274", - "summary": { - "record": "default/results/c360def0-d77e-4a3f-a1b0-5b0753e7d5af/records/c360def0-d77e-4a3f-a1b0-5b0753e7d5af", - "type": "tekton.dev/v1beta1.TaskRun", - "startTime": null, - "endTime": "2023-03-02T07:28:10Z", - "status": "SUCCESS", - "annotations": {} - } - } - ], - "nextPageToken": "" -} -``` - -### Record Response - -```json -{ - "name": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/records/640d1af3-9c75-4167-8167-4d8e4f39d403", - "id": "df3904b8-a6b8-468a-9e3f-8b9386bf3673", - "uid": "df3904b8-a6b8-468a-9e3f-8b9386bf3673", - "data": { - "type": "tekton.dev/v1beta1.TaskRun", - "value": "VGhpcyBpcyBhbiBleG1hcGxlIG9mIHJlY29yZCBkYXRhCg==" - }, - "etag": "df3904b8-a6b8-468a-9e3f-8b9386bf3673-1677742019012643389", - "createdTime": "2023-03-02T07:26:48.997424Z", - "createTime": "2023-03-02T07:26:48.997424Z", - "updatedTime": "2023-03-02T07:26:59.012643Z", - "updateTime": "2023-03-02T07:26:59.012643Z" -} -``` - -### Records List Response - -```json -{ - "records": [ - { - "name": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/records/640d1af3-9c75-4167-8167-4d8e4f39d403", - "id": "df3904b8-a6b8-468a-9e3f-8b9386bf3673", - "uid": "df3904b8-a6b8-468a-9e3f-8b9386bf3673", - "data": { - "type": "tekton.dev/v1beta1.TaskRun", - "value": "VGhpcyBpcyBhbiBleG1hcGxlIG9mIHJlY29yZCBkYXRhCg===" - }, - "etag": "df3904b8-a6b8-468a-9e3f-8b9386bf3673-1677742019012643389", - "createdTime": "2023-03-02T07:26:48.997424Z", - "createTime": "2023-03-02T07:26:48.997424Z", - "updatedTime": "2023-03-02T07:26:59.012643Z", - "updateTime": "2023-03-02T07:26:59.012643Z" - }, - { - "name": "default/results/640d1af3-9c75-4167-8167-4d8e4f39d403/records/77add742-5361-3b14-a1d3-2dae7e4977b2", - "id": "62e52c4d-9a61-4cf0-8f88-e816fcb0f84a", - "uid": "62e52c4d-9a61-4cf0-8f88-e816fcb0f84a", - "data": { - "type": "results.tekton.dev/v1alpha2.Log", - "value": "VGhpcyBpcyBhbiBleG1hcGxlIG9mIHJlY29yZCBkYXRhCg==" - }, - "etag": "62e52c4d-9a61-4cf0-8f88-e816fcb0f84a-1677742014245938484", - "createdTime": "2023-03-02T07:26:54.220068Z", - "createTime": "2023-03-02T07:26:54.220068Z", - "updatedTime": "2023-03-02T07:26:54.245938Z", - "updateTime": "2023-03-02T07:26:54.245938Z" - } - ], - "nextPageToken": "" -} -```