Skip to content

Commit

Permalink
sync REST parameters according to gRPC definitions
Browse files Browse the repository at this point in the history
- 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>
  • Loading branch information
avinal committed Aug 9, 2023
1 parent 222fc98 commit 61bccb6
Show file tree
Hide file tree
Showing 3 changed files with 167 additions and 664 deletions.
6 changes: 5 additions & 1 deletion docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,11 @@ is because we do not have health checking set up yet. Please refer <https://gith

### Using `curl` + `kubectl port-forward`

See the available REST endpoints in the [OpenAPI specification](api/rest-api-spec.md) docs. The API request URL is of the format `https://{server_url}/apis/results.tekton.dev/v1alpha2/parents/{name/path-to-the-resource}`. For debugging server_url is `localhost:port-exposed`.
See the available REST endpoints in
the [OpenAPI specification](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/tektoncd/results/main/docs/api/openapi.yaml).
The API request URL is of the
format `https://{server_url}/apis/results.tekton.dev/v1alpha2/parents/{name/path-to-the-resource}`. For debugging
server_url is `localhost:port-exposed`.

- Proxy the remote Service to localhost for REST. This will block, so run this in a separate shell or background the process.

Expand Down

0 comments on commit 61bccb6

Please sign in to comment.