scitran/core

View on GitHub
swagger/paths/analyses.yaml

Summary

Maintainability
Test Coverage
$template_arguments:
  tag: 'analyses'

/analyses/{AnalysisId}:
  $template: templates/analysis-item.yaml
  arguments:
    supportsDelete: false

/analyses/{AnalysisId}/inputs:
  $template: templates/analysis-files.yaml
  arguments:
    filegroup: inputs

/analyses/{AnalysisId}/inputs/{Filename}:
  $template: templates/analysis-files-create-ticket-filename.yaml
  arguments:
    filegroup: inputs

/analyses/{AnalysisId}/files:
  $template: templates/analysis-files.yaml
  arguments:
    filegroup: outputs

/analyses/{AnalysisId}/files/{Filename}:
  $template: templates/analysis-files-create-ticket-filename.yaml
  arguments:
    filegroup: outputs
  
/{ContainerName}/{ContainerId}/{SubcontainerName}/analyses:
  parameters:
    - name: ContainerName
      in: path
      type: string
      required: true
      enum:
        - groups
        - projects
        - sessions
        - acquisitions
        - collections
      description: The parent container type
    - name: ContainerId
      in: path
      type: string
      required: true
      description: The parent container id
    - name: SubcontainerName
      in: path
      type: string
      required: true
      enum:
        - all
        - projects
        - sessions
        - acquisitions
      description: The sub container type
  get:
    summary: Get nested analyses for a container
    description: >
      Returns analyses that belong to containers of the specified type that belong
      to ContainerId. 

      For example: `projects/{ProjectId}/acquisitions/analyses` will return any analyses 
      that have an acquisition that is under that project as a parent.

      The `all` keyword is also supported, for example: projects/{ProjectId}/all/analyses 
      will return any analyses that have any session or acquisition or the project itself as a parent.
    operationId: get_analyses
    tags:
    - analyses
    responses:
      '200': 
        description: The list of analyses
        schema:
          $ref: schemas/output/analyses-list.json