Skip to content

Commit dcf5e49

Browse files
committed
add ability to clone studyset
1 parent fa04453 commit dcf5e49

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

neurostore-openapi.yml

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -430,25 +430,29 @@ paths:
430430
- JSON-Web-Token: []
431431
- {}
432432
post:
433-
summary: POST/create a studyset
434-
responses:
435-
'200':
436-
description: OK
437-
content:
438-
application/json:
439-
schema:
440-
$ref: '#/components/schemas/studyset-return'
441-
tags:
442-
- store
443-
- studysets
444-
description: Create a studyset.
445-
security:
446-
- JSON-Web-Token: []
447-
requestBody:
448-
content:
449-
application/json:
450-
schema:
451-
$ref: '#/components/schemas/studyset-request'
433+
summary: POST/create a studyset
434+
parameters:
435+
- $ref: '#/components/parameters/source_id'
436+
- $ref: '#/components/parameters/source'
437+
- $ref: '#/components/parameters/copy_annotations'
438+
responses:
439+
'200':
440+
description: OK
441+
content:
442+
application/json:
443+
schema:
444+
$ref: '#/components/schemas/studyset-return'
445+
tags:
446+
- store
447+
- studysets
448+
description: Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
449+
security:
450+
- JSON-Web-Token: []
451+
requestBody:
452+
content:
453+
application/json:
454+
schema:
455+
$ref: '#/components/schemas/studyset-request'
452456
'/studysets/{id}':
453457
parameters:
454458
- schema:
@@ -2747,6 +2751,14 @@ components:
27472751
type: string
27482752
example: 1234567890ab
27492753
description: id of the resource you are either filtering/copying on
2754+
copy_annotations:
2755+
name: copy_annotations
2756+
in: query
2757+
required: false
2758+
schema:
2759+
type: boolean
2760+
default: true
2761+
description: When cloning a studyset, copy annotations and their notes when true (default).
27502762
name:
27512763
name: name
27522764
in: query

0 commit comments

Comments
 (0)