sayan-biswas commented 7 months ago

In the present implementation, a user cannot filter the data in the response message, a feature provided by modern API implementations. This is particularly needed for the List APIs as these APIs return the whole object in the list. In scenario where the list and object definition are big, there's a lot network bandwidth wasted because the response of the List API is mostly used to display a list of resources and the Get API is then used to fetch the individual resource. This feature provides an easy and basic way to filter the response message across all APIs, which reduces the size of the payload and hence allows faster transfer over network.

Changes

This feature add capabilities to filter the response message from across all APIs. AIP detail: https://google.aip.dev/157

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you review them:

[x] Has Docs included if any changes are user facing
[x] Has Tests included if any functionality added or changed
[x] Tested your changes locally (if this is a code change)
[x] Follows the commit message standard
[x] Meets the Tekton contributor standards (including functionality, content, code)
[x] Has a kind label. You can add a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
[x] Release notes block below has been updated with any user-facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
[ ] Release notes contain the string "action required" if the change requires additional action from users switching to the new release

Release Notes

API: Request message allows an additional parameter `fields` to filter the response message.

tekton-robot commented 7 months ago

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

tekton-robot commented 7 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To complete the pull request process, please ask for approval from sayan-biswas after the PR has been reviewed.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/tektoncd/results/blob/main/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

sayan-biswas commented 7 months ago

/test all

tekton-robot commented 7 months ago

The following is the coverage report on the affected files. Say /test pull-tekton-results-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
internal/fieldmask/fieldmask.go	Do not exist	70.1%

sayan-biswas commented 7 months ago

/test all

tekton-robot commented 7 months ago

The following is the coverage report on the affected files. Say /test pull-tekton-results-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
internal/fieldmask/fieldmask.go	Do not exist	70.1%

sayan-biswas commented 7 months ago

/test pull-tekton-results-integration-tests

sayan-biswas commented 7 months ago

/test pull-tekton-results-integration-tests

tekton-robot commented 5 months ago

The following is the coverage report on the affected files. Say /test pull-tekton-results-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
internal/fieldmask/fieldmask.go	Do not exist	70.1%

tekton-robot commented 5 months ago

The following is the coverage report on the affected files. Say /test pull-tekton-results-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/api/main.go	9.3%	9.1%	-0.2
internal/fieldmask/fieldmask.go	Do not exist	70.1%
pkg/api/server/config/config.go	Do not exist	0.0%
pkg/api/server/config/config.go	Do not exist	0.0%
pkg/api/server/features/features.go	Do not exist	85.3%

tekton-robot commented 5 months ago

The following is the coverage report on the affected files. Say /test pull-tekton-results-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/api/main.go	9.3%	9.1%	-0.2
internal/fieldmask/fieldmask.go	Do not exist	70.1%
pkg/api/server/config/config.go	Do not exist	0.0%
pkg/api/server/config/config.go	Do not exist	0.0%
pkg/api/server/features/features.go	Do not exist	85.3%

gabemontero commented 5 months ago

I don't seem to have permission to resolve comment threads @sayan-biswas

Feel free to resolve all of mine except https://github.com/tektoncd/results/pull/717#pullrequestreview-2038043891 and the one about submitting k8s events (at least until you respond to my clarification there).

gabemontero commented 4 months ago

bump @sayan-biswas on my last round of comments - https://github.com/tektoncd/results/pull/717#pullrequestreview-2038043891

tekton-robot commented 2 months ago

@sayan-biswas: PR needs rebase.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

sayan-biswas commented 2 months ago

@sayan-biswas Can you rebase it again without removing Gabe's performance tuning changes?

Sorry! I was caught up with other activities. I will rebase soon.

tektoncd / results

AIP-157 Partial response implementation #717

Changes

Submitter Checklist

Release Notes