Merge pull request #76 from neurostuff/enh/add_project_meta_analysis_…

…pagination [ENH] add project meta analysis pagination
neurostuff · Feb 29, 2024 · e5a1cb2 · e5a1cb2
2 parents 9a392d1 + c7a9b05
commit e5a1cb2
Showing 1 changed file with 73 additions and 0 deletions.
diff --git a/neurosynth-compose-openapi.yml b/neurosynth-compose-openapi.yml
@@ -102,6 +102,13 @@ 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'
+        - $ref: '#/components/parameters/desc'
       tags:
         - meta_analyses
         - get
@@ -744,6 +751,14 @@ 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'
+        - $ref: '#/components/parameters/desc'
     post:
       summary: ''
       responses:
@@ -1759,6 +1774,64 @@ components:
       in: header
       name: Compose-Upload-Key
   parameters:
+    desc:
+      name: desc
+      in: query
+      required: false
+      schema:
+        type: boolean
+      description: sort results by descending order (as opposed to ascending order)
+    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