results icon indicating copy to clipboard operation
results copied to clipboard

API OpenAPI spec for Log data is of incorrect type

Open iainsproat opened this issue 1 year ago • 5 comments

Expected Behavior

Tekton's OpenAPI specification for a Log specified that data contains a value of type string.

I would expect the OpenAPI specification to match the structure of the data returned by the API.

Actual Behavior

Tekton Result API returns data not as a string, but instead as an object with properties type and value.

Steps to Reproduce the Problem

  1. Return logs, e.g. curl -k -v https://127.0.0.1/apis/results.tekton.dev/v1alpha2/parents/default/results/5ba13b3a-6470-45b2-9f8f-c9c3c6eeeadb/logs
  2. Observe that the OpenAPI specification does not match the returned structure of the data

Additional Info

  • Kubernetes version:

    Output of kubectl version:

    (paste your output here)
    
  • Tekton Pipeline version:

    Client version: 0.31.1
    Pipeline version: v0.48.0
    

iainsproat avatar Jun 26 '23 10:06 iainsproat

Hi @iainsproat, sorry for the late response. /v1alpha2/parents/{parent}/results/{result_uid}/logs return a list of Record with properties named data of Any type. Any has properties type and value. So this is as expected.

xinnjie avatar Jul 12 '23 08:07 xinnjie

/close

xinnjie avatar Jul 12 '23 08:07 xinnjie

@xinnjie: You can't close an active issue/PR unless you authored it or you are a collaborator.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

tekton-robot avatar Jul 12 '23 08:07 tekton-robot

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale with a justification. Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with /close with a justification. If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

tekton-robot avatar Oct 10 '23 09:10 tekton-robot

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten with a justification. Rotten issues close after an additional 30d of inactivity. If this issue is safe to close now please do so with /close with a justification. If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

tekton-robot avatar Nov 09 '23 09:11 tekton-robot