Skip to content

Commit

Permalink
API documentation updates for Eval.List pagination
Browse files Browse the repository at this point in the history
  • Loading branch information
tgross committed Dec 8, 2021
1 parent 3250957 commit f589249
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .changelog/11648.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
api: Add pagination and filtering to Evaluations List API
```
18 changes: 18 additions & 0 deletions website/content/api-docs/evaluations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@ The table below shows this endpoint's support for
even number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.

- `last_token` `(string: "")` - This endpoint supports paging. The
`last_token` parameter accepts a string which is the `ID` field of
the last evaluation seen in the previous response, to request the
next page of responses.

- `per_page` `(int: 0)` - Specifies a maximum number of evaluations to
return for this request. If omitted, the response is not
paginated. The `ID` of the last evaluation in the response can be
used as the `last_token` of the next request to fetch additional
pages.

- `job` `(string: "")` - Filter the list of evaluations to a specific
job ID.

- `status` `(string: "")` - Filter the list of evaluations to a
specific evaluation status (one of "blocked", "pending", "complete",
"failed", or "canceled").

### Sample Request

```shell-session
Expand Down

0 comments on commit f589249

Please sign in to comment.