Skip to content

Commit

Permalink
docs: update filter information for namespace and filter query params
Browse files Browse the repository at this point in the history
  • Loading branch information
lgfa29 committed Feb 15, 2022
1 parent 13c76e3 commit bc50ebc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
10 changes: 4 additions & 6 deletions website/content/api-docs/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,11 @@ The table below shows this endpoint's support for
- `prefix` `(string: "")`- Specifies a string to filter deployments based on
an ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f) .This is specified as a query
string parameter and is backed by a data store index, so it can be used to
reduce the number of entries processed by `filter`.
string parameter and is used before any `filter` is applied.

- `namespace` `(string: "default")` - Specifies the target
namespace. Specifying `*` will return all evaluations across all
authorized namespaces. This parameter is backed by a data store index, so it
can be used to reduce the number of entries processed by `filter`.
- `namespace` `(string: "default")` - Specifies the target namespace.
Specifying `*` will return all evaluations across all authorized namespaces.
This parameter is used before any `filter` is applied.

- `next_token` `(string: "")` - This endpoint supports paging. The
`next_token` parameter accepts a string which is the `ID` field of
Expand Down
10 changes: 4 additions & 6 deletions website/content/api-docs/evaluations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ The table below shows this endpoint's support for
- `prefix` `(string: "")`- Specifies a string to filter evaluations based on an
ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter and is backed by a data store index, so it can be used to
reduce the number of entries processed by `filter`.
string parameter and and is used before any `filter` is applied.

- `next_token` `(string: "")` - This endpoint supports paging. The
`next_token` parameter accepts a string which is the `ID` field of
Expand All @@ -55,10 +54,9 @@ The table below shows this endpoint's support for
specific evaluation status (one of `blocked`, `pending`, `complete`,
`failed`, or `canceled`).

- `namespace` `(string: "default")` - Specifies the target
namespace. Specifying `*` will return all evaluations across all
authorized namespaces. This parameter is backed by a data store index, so it
can be used to reduce the number of entries processed by `filter`.
- `namespace` `(string: "default")` - Specifies the target namespace.
Specifying `*` will return all evaluations across all authorized namespaces.
This parameter is used before any `filter` is applied.

### Sample Request

Expand Down

0 comments on commit bc50ebc

Please sign in to comment.