diff --git a/neurostore-openapi.yml b/neurostore-openapi.yml index 8dee783..ead5806 100644 --- 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 diff --git a/neurosynth-compose-openapi.yml b/neurosynth-compose-openapi.yml index 452a2a0..693031a 100644 --- a/neurosynth-compose-openapi.yml +++ b/neurosynth-compose-openapi.yml @@ -198,6 +198,10 @@ paths: description: OK security: - JSON-Web-Token: [] + tags: + - compose + - meta_analyses + - delete /studysets: get: summary: Get a list of Studysets @@ -395,51 +399,6 @@ paths: schema: $ref: '#/components/schemas/annotation-update' description: update an existing annotation - /specifications: - get: - summary: Get a list of Specifications - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/specification-list' - '400': - $ref: '#/components/responses/bad-request' - description: list of meta-analysis specifications - tags: - - specifications - - get - - compose - parameters: [] - post: - summary: Create a Specification - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/specification-return' - '400': - $ref: '#/components/responses/bad-request' - '422': - description: Unprocessable Entity (WebDAV) - '500': - $ref: '#/components/responses/bad-request' - security: - - JSON-Web-Token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/specification-post-body' - description: create a new meta-analysis specification - tags: - - specifications - - post - - compose '/specifications/{id}': parameters: - schema: @@ -494,6 +453,20 @@ paths: - specifications - put - compose + delete: + summary: Delete a Specification + tags: + - compose + - specifications + - delete + responses: + '200': + description: OK + operationId: '' + x-stoplight: + id: zrfd1zeuselxb + security: + - JSON-Web-Token: [] /meta-analysis-results: get: summary: Your GET endpoint @@ -632,7 +605,7 @@ paths: $ref: '#/components/schemas/neurovault-collection-return' x-internal: true put: - summary: '' + summary: Update Neurovault Collection Reference responses: '200': description: OK @@ -814,12 +787,16 @@ paths: security: - JSON-Web-Token: [] tags: - - projects - compose + - projects + - delete /neurostore-studies: get: summary: Your GET endpoint - tags: [] + tags: + - compose + - neurostore-studies + - get responses: '200': description: OK @@ -846,6 +823,10 @@ paths: type: object properties: {} x-internal: true + tags: + - compose + - neurostore-studies + - post '/neurostore-studies/{id}': parameters: - schema: @@ -855,7 +836,10 @@ paths: required: true get: summary: Your GET endpoint - tags: [] + tags: + - compose + - neurostore-studies + - get responses: '200': description: OK @@ -882,10 +866,17 @@ paths: security: - JSON-Web-Token: [] x-internal: true + tags: + - compose + - neurostore-studies + - get /studyset-references: get: summary: Your GET endpoint - tags: [] + tags: + - compose + - studyset-references + - get responses: '200': description: OK @@ -907,7 +898,10 @@ paths: required: true get: summary: Your GET endpoint - tags: [] + tags: + - compose + - studyset-references + - get responses: '200': description: OK