Skip to content

[ENH] changes relative to feature display #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2025
Merged

[ENH] changes relative to feature display #86

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77f1c94
add feature
jdkent Feb 14, 2025
1d09703
remove pipeline run and rename run to study
jdkent Feb 25, 2025
26b5302
modify feature endpoint
jdkent Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 47 additions & 206 deletions neurostore-openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ paths:
summary: POST/create a pipeline
tags:
- pipelines
security:
- JSON-Web-Token: []
requestBody:
content:
application/json:
Expand All @@ -37,6 +39,8 @@ paths:
responses:
'201':
description: Created
'401':
description: Unauthorized - Authentication required
/pipelines/{id}:
get:
summary: GET a pipeline by ID
Expand Down Expand Up @@ -160,112 +164,48 @@ paths:
responses:
'204':
description: No Content

/pipeline-runs/:
/pipeline-study-results/:
get:
summary: GET a list of pipeline runs
tags:
- pipeline-runs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-list'
post:
summary: POST/create a pipeline run
tags:
- pipeline-runs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run'
responses:
'201':
description: Created
/pipeline-runs/{pipeline_run_id}:
get:
summary: GET a pipeline run by ID
tags:
- pipeline-runs
parameters:
- name: pipeline_run_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run'
put:
summary: PUT/update a pipeline run by ID
tags:
- pipeline-runs
parameters:
- name: pipeline_run_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run'
responses:
'200':
description: OK
delete:
summary: DELETE a pipeline run by ID
summary: GET a list of pipeline run results
tags:
- pipeline-runs
- pipeline-study-results
parameters:
- name: pipeline_run_id
in: path
required: true
- name: feature_filter
in: query
description: Filter results by feature content using jsonpath syntax
required: false
schema:
type: string
responses:
'204':
description: No Content

/pipeline-run-results/:
get:
summary: GET a list of pipeline run results
tags:
- pipeline-run-results
type: array
items:
type: string
example: 'groups.diagnosis=ADHD'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result-list'
$ref: '#/components/schemas/pipeline-study-result-list'
post:
summary: POST/create a pipeline run result
tags:
- pipeline-run-results
- pipeline-study-results
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result'
$ref: '#/components/schemas/pipeline-study-result'
responses:
'201':
description: Created
/pipeline-run-results/{pipeline_run_result_id}:
/pipeline-study-results/{pipeline_study_result_id}:
get:
summary: GET a pipeline run result by ID
tags:
- pipeline-run-results
- pipeline-study-results
parameters:
- name: pipeline_run_result_id
- name: pipeline_study_result_id
in: path
required: true
schema:
Expand All @@ -276,13 +216,13 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result'
$ref: '#/components/schemas/pipeline-study-result'
put:
summary: PUT/update a pipeline run result by ID
tags:
- pipeline-run-results
- pipeline-study-results
parameters:
- name: pipeline_run_result_id
- name: pipeline_study_result_id
in: path
required: true
schema:
Expand All @@ -291,90 +231,16 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result'
$ref: '#/components/schemas/pipeline-study-result'
responses:
'200':
description: OK
delete:
summary: DELETE a pipeline run result by ID
tags:
- pipeline-run-results
parameters:
- name: pipeline_run_result_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content

/pipeline-run-result-votes/:
get:
summary: GET a list of pipeline run result votes
tags:
- pipeline-run-result-votes
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result-vote-list'
post:
summary: POST/create a pipeline run result vote
tags:
- pipeline-run-result-votes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result-vote'
responses:
'201':
description: Created
/pipeline-run-result-votes/{pipeline_run_result_vote_id}:
get:
summary: GET a pipeline run result vote by ID
tags:
- pipeline-run-result-votes
parameters:
- name: pipeline_run_result_vote_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result-vote'
put:
summary: PUT/update a pipeline run result vote by ID
tags:
- pipeline-run-result-votes
parameters:
- name: pipeline_run_result_vote_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/pipeline-run-result-vote'
responses:
'200':
description: OK
delete:
summary: DELETE a pipeline run result vote by ID
tags:
- pipeline-run-result-votes
- pipeline-study-results
parameters:
- name: pipeline_run_result_vote_id
- name: pipeline_study_result_id
in: path
required: true
schema:
Expand Down Expand Up @@ -1189,6 +1055,18 @@ paths:
schema:
$ref: '#/components/schemas/base-study-list'
parameters:
- name: feature_filter
in: query
description: Filter studies by features
required: false
schema:
type: string
- name: feature_display
in: query
description: display features from pipelines
required: false
schema:
type: string
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
Expand Down Expand Up @@ -1423,62 +1301,22 @@ components:
$ref: '#/components/schemas/pipeline-config'
metadata:
$ref: '#/components/schemas/metadata'
pipeline-run:
pipeline-study-result:
type: object
properties:
id:
type: string
status:
type: string
started_at:
type: string
finished_at:
type: string
pipeline-run-list:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/pipeline-run'
metadata:
$ref: '#/components/schemas/metadata'
pipeline-run-result:
type: object
properties:
id:
type: string
pipeline_run_id:
pipeline_config_id:
type: string
data:
type: object
pipeline-run-result-list:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/pipeline-run-result'
metadata:
$ref: '#/components/schemas/metadata'
pipeline-run-result-vote:
type: object
properties:
id:
type: string
pipeline_run_result_id:
type: string
user_id:
type: string
vote:
type: integer
pipeline-run-result-vote-list:
pipeline-study-result-list:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/pipeline-run-result-vote'
$ref: '#/components/schemas/pipeline-study-result'
metadata:
$ref: '#/components/schemas/metadata'
studyset-return:
Expand Down Expand Up @@ -2368,6 +2206,9 @@ components:
allOf:
- $ref: '#/components/schemas/base-study'
- $ref: '#/components/schemas/resource-attributes'
properties:
features:
type: object
base-study-list:
title: base-study-list
x-stoplight:
Expand Down