scitran/core

$template_arguments:
  resource: session
  tag: sessions
  parameter: SessionId

/sessions:
  $template: templates/container.yaml
  arguments:
    list-output-schema: schemas/output/session-list.json
    create-input-schema: schemas/input/session.json

/sessions/{SessionId}:
  $template: templates/container-item.yaml
  arguments:
    update-input-schema: schemas/input/session.json
    get-output-schema: schemas/output/session.json
    delete-description: Read-write project permissions are required to delete a session. </br>Admin project permissions are required if the session or it's acquisitions contain data uploaded by sources other than users and jobs.

/sessions/{SessionId}/info:
  $template: templates/container-item-info.yaml
  
/sessions/{SessionId}/jobs:
  parameters:
    - in: path
      type: string
      name: SessionId
      required: true
  get:
    summary: Return any jobs that use inputs from this session
    operationId: get_session_jobs
    tags:
    - 'sessions'
    parameters:
      - in: query
        type: string
        name: states
        description: filter results by job state
      - in: query
        type: string
        name: tags
        description: filter results by job tags
    responses:
      '200':
        description: ''
        schema:
          $ref: schemas/output/session-jobs.json

# ===== Tags =====
/sessions/{SessionId}/tags:
  $template: templates/tags.yaml
/sessions/{SessionId}/tags/{TagValue}:
  $template: templates/tags-tag.yaml

# ===== Files =====
/sessions/{SessionId}/files:
  $template: templates/file-list-upload.yaml
/sessions/{SessionId}/files/{FileName}:
  $template: templates/file-item.yaml
/sessions/{SessionId}/files/{FileName}/info:
  $template: templates/file-item-info.yaml

# ===== Notes =====
/sessions/{SessionId}/notes:
  $template: templates/notes.yaml
/sessions/{SessionId}/notes/{NoteId}:
  $template: templates/notes-note.yaml

/sessions/{SessionId}/acquisitions:
  parameters:
    - in: path
      type: string
      name: SessionId
      required: true
  get:
    summary: List acquisitions in a session
    operationId: get_session_acquisitions
    tags:
    - 'sessions'
    responses:
      '200':
        description: ''
        schema:
          $ref: schemas/output/acquisition-list.json


# ===== Analyses =====
/sessions/{SessionId}/analyses:
  $template: templates/analyses-list.yaml
  arguments:
    allowCreate: true
/sessions/{SessionId}/analyses/{AnalysisId}:
  $template: templates/analysis-item.yaml
  arguments:
    supportsDelete: true
/sessions/{SessionId}/analyses/{AnalysisId}/inputs:
  $template: templates/analysis-files.yaml
  arguments:
    filegroup: inputs
/sessions/{SessionId}/analyses/{AnalysisId}/inputs/{Filename}:
  $template: templates/analysis-files-create-ticket-filename.yaml
  arguments:
    filegroup: inputs
/sessions/{SessionId}/analyses/{AnalysisId}/files:
  $template: templates/analysis-files.yaml
  arguments:
    filegroup: outputs
/sessions/{SessionId}/analyses/{AnalysisId}/files/{Filename}:
  $template: templates/analysis-files-create-ticket-filename.yaml
  arguments:
    filegroup: outputs
/sessions/{SessionId}/analyses/{AnalysisId}/notes:
  $template: templates/analysis-notes.yaml
/sessions/{SessionId}/analyses/{AnalysisId}/notes/{NoteId}:
  $template: templates/analysis-notes-item.yaml