-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1073 from scitran/swagger-fix-undocumented
Document missing and under-documented endpoints
- Loading branch information
Showing
75 changed files
with
1,758 additions
and
231 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| [{ | ||
| "category": "converter", | ||
| "gear": { | ||
| "inputs": { | ||
| "audio": { | ||
| "base": "file", | ||
| "description": "Any audio file. Plain speech suggested!" | ||
| } | ||
| }, | ||
| "maintainer": "Nathaniel Kofalt", | ||
| "description": "Detects the speech content of an audio file, using the machine-learning DeepSpeech library by Mozilla.", | ||
| "license": "Other", | ||
| "author": "Nathaniel Kofalt", | ||
| "url": "", | ||
| "label": "Speech Recognition", | ||
| "source": "https://github.com/mozilla/DeepSpeech", | ||
| "version": "1", | ||
| "custom": { | ||
| "gear-builder": { | ||
| "image": "gear-builder-kdfqapbezk-20171219165918", | ||
| "container": "c15189b625a0ea450cafbb24ef0df03c26cc8cf151181976ec4289801e191032" | ||
| } | ||
| }, | ||
| "config": {}, | ||
| "name": "speech-recognition" | ||
| }, | ||
| "created": "2017-12-20T00:09:50.381000+00:00", | ||
| "exchange": { | ||
| "git-commit": "local", | ||
| "rootfs-hash": "sha384:e01d925f90b097b554be0f802ef6ebb9f07000d7a6a2a0c3a25dac26893d4ac2414381e2c8e60f4b58b27c7fe8e56099", | ||
| "rootfs-url": "/api/gears/temp/5a39aa4e07a393001b663910" | ||
| }, | ||
| "modified": "2017-12-20T00:09:50.381000+00:00", | ||
| "_id": "5a39aa4e07a393001b663910" | ||
| }] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "category": "converter", | ||
| "gear": { | ||
| "inputs": { | ||
| "audio": { | ||
| "base": "file", | ||
| "description": "Any audio file. Plain speech suggested!" | ||
| } | ||
| }, | ||
| "maintainer": "Nathaniel Kofalt", | ||
| "description": "Detects the speech content of an audio file, using the machine-learning DeepSpeech library by Mozilla.", | ||
| "license": "Other", | ||
| "author": "Nathaniel Kofalt", | ||
| "url": "", | ||
| "label": "Speech Recognition", | ||
| "source": "https://github.com/mozilla/DeepSpeech", | ||
| "version": "1", | ||
| "custom": { | ||
| "gear-builder": { | ||
| "image": "gear-builder-kdfqapbezk-20171219165918", | ||
| "container": "c15189b625a0ea450cafbb24ef0df03c26cc8cf151181976ec4289801e191032" | ||
| } | ||
| }, | ||
| "config": {}, | ||
| "name": "speech-recognition" | ||
| }, | ||
| "created": "2017-12-20T00:09:50.381000+00:00", | ||
| "exchange": { | ||
| "git-commit": "local", | ||
| "rootfs-hash": "sha384:e01d925f90b097b554be0f802ef6ebb9f07000d7a6a2a0c3a25dac26893d4ac2414381e2c8e60f4b58b27c7fe8e56099", | ||
| "rootfs-url": "/api/gears/temp/5a39aa4e07a393001b663910" | ||
| }, | ||
| "modified": "2017-12-20T00:09:50.381000+00:00", | ||
| "_id": "5a39aa4e07a393001b663910" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "_id": "5a12f2923306be0016179f47", | ||
| "name": "dcm2niix", | ||
| "alg": "dcm2niix", | ||
| "any": [], | ||
| "all": [ | ||
| { | ||
| "regex": true, | ||
| "type": "file.measurements", | ||
| "value": "^(?!non-image).+$" | ||
| }, | ||
| { | ||
| "type": "file.type", | ||
| "value": "nifti" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| $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 | ||
|
|
Oops, something went wrong.