From ac8fec96c4f315ce112e23576cddc7476b929a48 Mon Sep 17 00:00:00 2001 From: jonathan zollinger Date: Fri, 1 May 2026 16:31:30 -0600 Subject: [PATCH 1/3] docs: correct export javadocs --- .../java/lol/pbu/z4j/client/SearchClient.java | 29 ++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/src/main/java/lol/pbu/z4j/client/SearchClient.java b/src/main/java/lol/pbu/z4j/client/SearchClient.java index 26cdfd0..d6cce18 100644 --- a/src/main/java/lol/pbu/z4j/client/SearchClient.java +++ b/src/main/java/lol/pbu/z4j/client/SearchClient.java @@ -56,7 +56,34 @@ public interface SearchClient { /** *

{@summary Export Search Results}

- *

Exports a set of results. See Query syntax for the syntax of the {@code query} parameter.

Use this endpoint for search queries that will return more than 1000 results. The result set is ordered only by the {@code created_at} attribute.

The search only returns results of a single object type. The following object types are supported: ticket, organization, user, or group.

You must specify the type in the {@code filter[type]} parameter. Searches with type in the query string will result in an error.

Allowed for Agents

Pagination

See Pagination.

Returns a maximum of 1000 records per page. The number of results shown in a page is determined by the {@code page[size]} parameter.

Note: You may experience a speed reduction or a timeout if you request 1000 results per page and you have many archived tickets in the results. Try reducing the number of results per page. We recommend 100 results per page.

The cursor specified by the {@code after_cursor} property in a response expires after one hour.

For more information on cursor-based pagination, see the following articles:

Export Search Results Limits

This API endpoint is rate-limited to 100 requests per minute per account. The limit also counts towards the global API rate limit.

+ *

Exports a set of results. See Query + * syntax for the syntax of the {@code query} parameter.

Use this endpoint for search queries that will + * return more than 1000 results. The result set is ordered only by the {@code created_at} attribute.

The search + * only returns results of a single object type. The following object types are supported: ticket, organization, user, + * or group.

You must specify the type in the {@code filter[type]} parameter. Searches with type in the query + * string will result in an error.

Allowed for Agents

Pagination

+ *

See Pagination.

+ * Returns a maximum of 1000 records per page. The number of results shown in a page is determined by the {@code + * page[size]} parameter.

Note: You may experience a speed reduction or a timeout if you + * request 1000 results per page and you have many archived tickets in the results. Try reducing the number of results + * per page. We recommend 100 results per page.

The cursor specified by the {@code after_cursor} property in a + * response expires after one hour.

For more information on cursor-based pagination, see the following + * articles:

+ *

Export Search Results Limits

This API endpoint is rate-limited to 100 requests per minute per account. + * The limit also counts towards the global API rate + * limit.

* * @param query Returns the search results. See Query syntax for details on the {@code query} parameter. For details on the query syntax, see the Zendesk Support search reference. (required) * @param pageSize The number of results shown in a page. (required) From ad42a039c9b81a0bd6c0e0c1b748f23c8b3d9190 Mon Sep 17 00:00:00 2001 From: jonathan zollinger Date: Fri, 1 May 2026 17:12:01 -0600 Subject: [PATCH 2/3] docs: correct vars and whitespace --- .../java/lol/pbu/z4j/client/SearchClient.java | 21 +++++--- .../java/lol/pbu/z4j/client/TicketClient.java | 2 +- .../pbu/z4j/client/SearchClientSpec.groovy | 53 ++++++++++++++++--- 3 files changed, 62 insertions(+), 14 deletions(-) diff --git a/src/main/java/lol/pbu/z4j/client/SearchClient.java b/src/main/java/lol/pbu/z4j/client/SearchClient.java index d6cce18..9958570 100644 --- a/src/main/java/lol/pbu/z4j/client/SearchClient.java +++ b/src/main/java/lol/pbu/z4j/client/SearchClient.java @@ -21,6 +21,7 @@ import io.micronaut.http.client.annotation.Client; import io.micronaut.retry.annotation.Retryable; import jakarta.validation.Valid; +import jakarta.validation.constraints.Max; import jakarta.validation.constraints.NotNull; import lol.pbu.z4j.model.SearchExportType; import lol.pbu.z4j.model.SearchResponse; @@ -57,12 +58,12 @@ public interface SearchClient { /** *

{@summary Export Search Results}

*

Exports a set of results. See Query - * syntax for the syntax of the {@code query} parameter.

Use this endpoint for search queries that will - * return more than 1000 results. The result set is ordered only by the {@code created_at} attribute.

The search - * only returns results of a single object type. The following object types are supported: ticket, organization, user, - * or group.

You must specify the type in the {@code filter[type]} parameter. Searches with type in the query - * string will result in an error.

Allowed for Agents

Pagination

+ * href='https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#query-syntax'>Query + * syntax for the syntax of the {@code query} parameter.

Use this endpoint for search queries that will + * return more than 1000 results. The result set is ordered only by the {@code created_at} attribute.

The search + * only returns results of a single object type. The following object types are supported: ticket, organization, user, + * or group.

You must specify the type in the {@code filter[type]} parameter. Searches with type in the query + * string will result in an error.

Allowed for Agents

Pagination

*