add return_all parameter to neurostore

neurostuff · Feb 17, 2024 · 61b4d04 · 61b4d04
1 parent 71f16d9
commit 61b4d04
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/neurostore-openapi.yml b/neurostore-openapi.yml
@@ -40,6 +40,7 @@ paths:
         - $ref: '#/components/parameters/source'
         - $ref: '#/components/parameters/authors'
         - $ref: '#/components/parameters/user_id'
+        - $ref: '#/components/parameters/return_all'
       security:
         - JSON-Web-Token: []
         - {}
@@ -161,6 +162,7 @@ paths:
         - $ref: '#/components/parameters/pmid'
         - $ref: '#/components/parameters/doi'
         - $ref: '#/components/parameters/flat'
+        - $ref: '#/components/parameters/return_all'
       security:
         - JSON-Web-Token: []
         - {}
@@ -833,6 +835,7 @@ paths:
         - $ref: '#/components/parameters/doi'
         - $ref: '#/components/parameters/flat'
         - $ref: '#/components/parameters/info'
+        - $ref: '#/components/parameters/return_all'
       security:
         - JSON-Web-Token: []
         - {}
@@ -2019,6 +2022,13 @@ components:
       schema:
         type: boolean
       description: return the content as gzipped content
+    return_all:
+      name: return_all
+      in: query
+      required: false
+      schema:
+        type: boolean
+      description: 'return all results at an endpoint (WARNING: could take a while)'
   securitySchemes:
     JSON-Web-Token:
       type: http