-
Notifications
You must be signed in to change notification settings - Fork 73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OpenAPI misleading UID
description about Result
API
#533
Comments
/kind documentation |
Results
APIUID
description about Result
API
@enarha @sayan-biswas @khrm |
@xinnjie the difference between gRPC method and REST call. The gRPC method expects a single parameter called |
My point is that message Result {
string name = 1 [(google.api.resource_reference) = {
child_type: "tekton.results.v1alpha2/Result"
}];
// Server assigned identifier of the Result.
// DEPRECATED: use uid instead.
string id = 2 [(google.api.field_behavior) = OUTPUT_ONLY, deprecated = true];
// Server assigned identifier of the Result.
string uid = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
...
} Maybe we could call Names could be discussed as long as long they do not collide. |
/remove-kind bug |
Agree with @xinnjie. |
Okay let me open a fix. |
/assign |
- remove uid from parameter, replace with _-name instead - fix openapi syntax warnings - fixes tektoncd#533 Signed-off-by: Avinal Kumar <avinal@redhat.com>
- remove uid from parameter, replace with _-name instead - fix openapi syntax warnings - remove rest-api markdown docs - fixes tektoncd#533 Signed-off-by: Avinal Kumar <avinal@redhat.com>
- remove uid from parameter, replace with _-name instead - fix openapi syntax warnings - remove rest-api markdown docs - fixes tektoncd#533 Signed-off-by: Avinal Kumar <avinal@redhat.com>
Issues go stale after 90d of inactivity. /lifecycle stale Send feedback to tektoncd/plumbing. |
/remove-lifecycle stale |
Currently doc mix-use Result UID as both name and UID of result. The terminology should be sorted out, otherwise users may get confused.
About terminology
name of
Result
Here result
name
refer to the name decided by the clients of Results API Server. And (from implementation aspect) currently Watcher useTaskrun
/Pipelinerun
UID as resultname
.UID of
Result
UID
refer to the id decided by Results API Server when insertingResult
object.Actual Behavior
While
GetResultRequest
needs specifying result name to queryResult
, OpenAPI document thatget /v1alpha2/parents/{parent}/results/{result_uid}
get a single result given the UID.There are also same wrong description about update, delete of
Result
GRPC service definition:
OpenAPI doc:
Expected Behavior
OpenAPI
summary
ofget /v1alpha2/parents/{parent}/results/{result_uid}
changeGet a single result given the UID
toGet a single result given name
and so on.Steps to Reproduce the Problem
Additional Info
Kubernetes version:
Output of
kubectl version
:Tekton Pipeline version:
Output of
tkn version
orkubectl get pods -n tekton-pipelines -l app=tekton-pipelines-controller -o=jsonpath='{.items[0].metadata.labels.version}'
Tekton Results version:
current
main
branchThe text was updated successfully, but these errors were encountered: