Skip to content

sync REST parameters according to gRPC definitions #554

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.

Sign up for GitHub

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

Open
avinal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

sync REST parameters according to gRPC definitions #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/DEVELOPMENT.md
View file
Open in desktop
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).
Copy link
Contributor

@adambkaplan adambkaplan Aug 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An interesting thought - running our own Swagger instance within https://tekton.dev/docs/

Copy link
Member Author

@avinal avinal Aug 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was thinking of proposing this in our next WG call. Let me add it.

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
Loading