From ac2f243d12e739c39363c04f9adba102496c77a8 Mon Sep 17 00:00:00 2001 From: Gavin Brown Date: Mon, 3 Aug 2026 09:22:33 +0100 Subject: [PATCH 1/4] rename testRequestSearchResult to testRequestSearchResultItem --- rst-api-spec.yaml.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rst-api-spec.yaml.in b/rst-api-spec.yaml.in index 5b00870..32585f9 100644 --- a/rst-api-spec.yaml.in +++ b/rst-api-spec.yaml.in @@ -522,7 +522,7 @@ paths: type: array minItems: 0 items: - $ref: "#/components/schemas/testRequestSearchResult" + $ref: "#/components/schemas/testRequestSearchResultItem" /v1/table: post: @@ -839,7 +839,7 @@ components: type: boolean default: false - testRequestSearchResult: + testRequestSearchResultItem: description: | An abbreviated representation of a test object that is included in search result. From c3ed369fee5686d00b2ecc0172ff8e9fb7421bb8 Mon Sep 17 00:00:00 2001 From: Gavin Brown Date: Mon, 3 Aug 2026 09:44:54 +0100 Subject: [PATCH 2/4] add page and limit parameters to /v1/tests --- rst-api-spec.yaml.in | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/rst-api-spec.yaml.in b/rst-api-spec.yaml.in index 32585f9..b28ac10 100644 --- a/rst-api-spec.yaml.in +++ b/rst-api-spec.yaml.in @@ -493,6 +493,18 @@ paths: type: string format: hostname x-field-extra-annotation: "@org.icann.rst.commons.annotations.ValidHostname" + - name: page + description: the page number. + in: query + required: false + schema: + $ref: "#/components/schemas/testRequestSearchPageNumber" + - name: limit + description: the page size. + in: query + required: false + schema: + $ref: "#/components/schemas/testRequestSearchPageLimit" - name: applicationID description: | limit results to specific a application ID (internal users only). @@ -839,6 +851,21 @@ components: type: boolean default: false + testRequestSearchPageNumber: + description: + the page number. + type: integer + default: 1 + minimum: 1 + + testRequestSearchPageLimit: + description: + the page size. + type: integer + default: 1 + minimum: 10 + maximum: 100 + testRequestSearchResultItem: description: | An abbreviated representation of a test object that is included in From df85b80d014af5282ea29f3b3f0964b7fc7eecf0 Mon Sep 17 00:00:00 2001 From: Gavin Brown Date: Mon, 3 Aug 2026 09:45:42 +0100 Subject: [PATCH 3/4] define new type for search results that includes pagination --- rst-api-spec.yaml.in | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/rst-api-spec.yaml.in b/rst-api-spec.yaml.in index b28ac10..679fc74 100644 --- a/rst-api-spec.yaml.in +++ b/rst-api-spec.yaml.in @@ -531,10 +531,7 @@ paths: content: "application/json": schema: - type: array - minItems: 0 - items: - $ref: "#/components/schemas/testRequestSearchResultItem" + $ref: "#/components/schemas/testRequestSearchResults" /v1/table: post: @@ -866,6 +863,38 @@ components: minimum: 10 maximum: 100 + testRequestSearchResults: + description: | + The results of a search. + type: object + additionalProperties: false + required: + - page + - limit + - results + properties: + page: + $ref: "#/components/schemas/testRequestSearchPageNumber" + limit: + $ref: "#/components/schemas/testRequestSearchPageLimit" + next_page: + description: URL of the next page of results (if any). + type: string + format: url + nullable: true + prev_page: + description: URL of the previous page of results (if any). + type: string + format: url + nullable: true + results: + description: the search results. + type: array + minItems: 0 + maxItems: 100 + items: + $ref: "#/components/schemas/testRequestSearchResultItem" + testRequestSearchResultItem: description: | An abbreviated representation of a test object that is included in From 64765f1e4e553af14c4a900a61843991ce73cae6 Mon Sep 17 00:00:00 2001 From: Gavin Brown Date: Thu, 27 Aug 2026 10:57:02 +0100 Subject: [PATCH 4/4] fix default value for testRequestSearchPageLimit --- rst-api-spec.yaml.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rst-api-spec.yaml.in b/rst-api-spec.yaml.in index 679fc74..36813d7 100644 --- a/rst-api-spec.yaml.in +++ b/rst-api-spec.yaml.in @@ -859,7 +859,7 @@ components: description: the page size. type: integer - default: 1 + default: 10 minimum: 10 maximum: 100