Skip to content

Commit 85b2c57

Browse files
committed
update readme
1 parent aeaa211 commit 85b2c57

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ final CurrentUserResponse myUser = client.getUser();
4747
final ListOrganizationsResponse organizations = client.listOrganizations();
4848

4949
/*
50-
* To search for builds:
50+
* To search for builds:
51+
* https://buildkite.com/docs/apis/rest-api/builds#list-all-builds
52+
*/
5153
*/
5254
final BuildFilters filters = BuildFilters.newBuilder()
5355
// Retrieve 1st page, with each page having 25 results
@@ -60,10 +62,10 @@ final BuildFilters filters = BuildFilters.newBuilder()
6062
final ListBuildsResponse buildsResult = client.listBuilds(filters);
6163

6264
/*
63-
* To retrieve the 3rd page of the above query simply do:
65+
* To retrieve the 2n page of the above query simply do:
6466
*/
6567
if (buildsResult.hasNextPage()) {
66-
final ListBuildsResponse buildsPage2 = client.nextPage(buildsPage1);
68+
final ListBuildsResponse buildsPage2 = client.nextPage(buildsResult);
6769
}
6870

6971
/*
@@ -100,6 +102,11 @@ We love contributions, but it's important that your pull request adhere to some
100102

101103
# Other Notes
102104

105+
## Not all endpoints supported yet.
106+
While the functionality that exists in the library should be considered stable, and every attempt will be made to avoid breaking backwards
107+
compatibility as the library is expanded, it should be noted that not all REST endpoints are currently implemented.
108+
109+
If you require an end point not yet supported, either submit an issue with a feature request, or submit a pull request implementing it.
103110

104111
## Releasing
105112

0 commit comments

Comments
 (0)