diff options
| author | Karthik Nayak <knayak@gitlab.com> | 2023-10-04 14:08:26 +0300 |
|---|---|---|
| committer | Karthik Nayak <knayak@gitlab.com> | 2023-10-12 17:22:53 +0300 |
| commit | fa8c26072f17b5754d9c2d3310e888236df34d3e (patch) | |
| tree | e28c3b53507df74e3b9150be2eb7dc30bc6d9dd6 /proto/shared.proto | |
| parent | 9c719375e674b55f018094cbdb866ce5cf21e7f8 (diff) | |
proto: Add documentation for PaginationParams and PaginationCursor
The documentation for PaginationParams and PaginationCursor is not
consistent at this point. So let's make it consistent and also point to
the documentation for the messages themselves to centralize the
documenation.
Diffstat (limited to 'proto/shared.proto')
| -rw-r--r-- | proto/shared.proto | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/proto/shared.proto b/proto/shared.proto index 861fa7eb8..c8d172fb5 100644 --- a/proto/shared.proto +++ b/proto/shared.proto @@ -203,7 +203,7 @@ message ObjectPool { Repository repository = 1 [(gitaly.repository)=true]; } -// PaginationParameter ... +// PaginationParameter controls pagination within RPCs. message PaginationParameter { // page_token instructs pagination to start sending results after the provided page // token appears. A page token allows for a generic pattern to uniquely @@ -220,7 +220,7 @@ message PaginationParameter { int32 limit = 2; } -// PaginationCursor ... +// PaginationCursor defines the page token clients should use to fetch the next page. message PaginationCursor { // next_cursor is an opaque token provided to the caller to indicate what the caller // should present as a page_token to get subsequent results. |