Story (Required)

As a Results user I want to get data using CLI. I want to easily understand what might be wrong when an error occurs.

Background (Required)

"opc results" often shows error messages like those below without explaining what is expected, whether the user made a mistake of if it's a server-side error.

Can say explicitly which arg is missing

opc results --addr tekton-results-api-service-openshift-pipelines.example.com --insecure list
Error: accepts 1 arg(s), received 0

Can at least instruct the user to double-check the results API endpoint (missing :443 in this case)

$ opc results --addr tekton-results-api-service-openshift-pipelines.example.com --insecure list testloki
Dial: context deadline exceeded
Error: context deadline exceeded

$ opc results --addr tekton-results-api-service-openshift-pipelines.example.com:443 --insecure list testloki
Name                                                   Start                                   Update
testloki/results/6aa9cb60-5196-4383-987e-dc8af2c58555  2024-09-23 10:53:44 +0200 CEST          2024-09-23 10:53:48 +0200 CEST

Out of scope

<Defines what is not included in this story>

Approach (Required)

<Description of the general technical path on how to achieve the goal of the story. Include details like json schema, class definitions>

Dependencies

<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

Acceptance Criteria (Mandatory)

<Describe edge cases to consider when implementing the story and defining tests>

<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>

INVEST Checklist

Dependencies identified

Blockers noted and expected delivery timelines set

Design is implementable

Acceptance criteria agreed upon

Story estimated

Legend

Unknown

Verified

Unsatisfied

Done Checklist

• Code is completed, reviewed, documented and checked in
• Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
• Continuous Delivery pipeline(s) is able to proceed with new code included
• Customer facing documentation, API docs etc. are produced/updated, reviewed and published
• Acceptance criteria are met