From 6a1f720e8a35d0230150aaca519b92c90835ac2d Mon Sep 17 00:00:00 2001 From: "james.kent@austin.utexas.edu" Date: Wed, 28 Feb 2024 18:11:24 -0600 Subject: [PATCH] add page search paramaters --- neurosynth-compose-openapi.yml | 64 ++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/neurosynth-compose-openapi.yml b/neurosynth-compose-openapi.yml index 452a2a0..372820e 100644 --- a/neurosynth-compose-openapi.yml +++ b/neurosynth-compose-openapi.yml @@ -102,6 +102,12 @@ paths: parameters: - $ref: '#/components/parameters/nested' - $ref: '#/components/parameters/ids' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/page_size' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/description' + - $ref: '#/components/parameters/sort' tags: - meta_analyses - get @@ -744,6 +750,13 @@ paths: security: - JSON-Web-Token: [] - {} + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/page_size' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/description' + - $ref: '#/components/parameters/sort' post: summary: '' responses: @@ -1759,6 +1772,57 @@ components: in: header name: Compose-Upload-Key parameters: + sort: + name: sort + in: query + required: false + schema: + type: string + default: created_at + description: Parameter to sort results on + search: + name: search + in: query + required: false + schema: + type: string + minLength: 1 + example: imagin + description: search for entries that contain the substring + description: + name: description + in: query + required: false + schema: + type: string + description: search description field for a term + name: + name: name + in: query + required: false + schema: + type: string + description: search the name field for a term + page: + name: page + in: query + required: false + schema: + type: integer + format: int32 + minimum: 0 + description: page of results + page_size: + name: page_size + in: query + required: false + schema: + type: integer + maximum: 30000 + exclusiveMaximum: true + minimum: 1 + format: int32 + description: number of elements to return on a page nested: name: nested in: query