Skip to content

Commit

Permalink
Merge a559f55 into 19e9207
Browse files Browse the repository at this point in the history
  • Loading branch information
Diego committed Jan 18, 2019
2 parents 19e9207 + a559f55 commit c0a1019
Show file tree
Hide file tree
Showing 6 changed files with 127 additions and 620 deletions.
224 changes: 0 additions & 224 deletions docs/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,83 +7,6 @@
},
"parameters": {},
"paths": {
"/api/cwl/remote": {
"post": {
"consumes": [
"application/json"
],
"description": "This resource is expecting JSON data with all the necessary information to instantiate a cwl workflow from a remote repository.",
"operationId": "run_cwl_workflow_from_remote",
"parameters": [
{
"description": "Required. UUID of workflow owner.",
"in": "query",
"name": "user",
"required": true,
"type": "string"
},
{
"description": "Workflow information in JSON format with all the necessary data to instantiate a cwl workflow from a remote repository such as GitHub.",
"in": "body",
"name": "workflow_data",
"required": true,
"schema": {
"properties": {
"nparallel": {
"type": "integer"
},
"preset_pars": {
"description": "Workflow parameters.",
"type": "object"
},
"toplevel": {
"description": "cwl toplevel argument. It represents the remote repository where the workflow should be pulled from.",
"type": "string"
},
"workflow": {
"description": "cwl workflow parameter. It represents the name of the workflow spec file name inside the remote repository.",
"type": "string"
}
},
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Request succeeded. The workflow has been instantiated.",
"examples": {
"application/json": {
"message": "Workflow successfully launched",
"workflow_id": "cdcf48b1-c2f3-4693-8230-b066e088c6ac",
"workflow_name": "mytest-1"
}
},
"schema": {
"properties": {
"message": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"workflow_name": {
"type": "string"
}
},
"type": "object"
}
},
"400": {
"description": "Request failed. The incoming data specification seems malformed"
}
},
"summary": "Creates a new cwl workflow from a remote repository."
}
},
"/api/workflows": {
"get": {
"description": "This resource is expecting a user UUID. The information related to all workflows for a given user will be served as JSON",
Expand Down Expand Up @@ -1020,153 +943,6 @@
},
"summary": "Returns the requested file."
}
},
"/api/yadage/remote": {
"post": {
"consumes": [
"application/json"
],
"description": "This resource is expecting JSON data with all the necessary information to instantiate a yadage workflow from a remote repository.",
"operationId": "run_yadage_workflow_from_remote",
"parameters": [
{
"description": "Required. UUID of workflow owner.",
"in": "query",
"name": "user",
"required": true,
"type": "string"
},
{
"description": "Workflow information in JSON format with all the necessary data to instantiate a yadage workflow from a remote repository such as GitHub.",
"in": "body",
"name": "workflow_data",
"required": true,
"schema": {
"properties": {
"nparallel": {
"type": "integer"
},
"preset_pars": {
"description": "Workflow parameters.",
"type": "object"
},
"toplevel": {
"description": "Yadage toplevel argument. It represents the remote repository where the workflow should be pulled from.",
"type": "string"
},
"workflow": {
"description": "Yadage workflow parameter. It represents the name of the workflow spec file name inside the remote repository.",
"type": "string"
}
},
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Request succeeded. The workflow has been instantiated.",
"examples": {
"application/json": {
"message": "Workflow successfully launched",
"workflow_id": "cdcf48b1-c2f3-4693-8230-b066e088c6ac",
"workflow_name": "mytest-1"
}
},
"schema": {
"properties": {
"message": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"workflow_name": {
"type": "string"
}
},
"type": "object"
}
},
"400": {
"description": "Request failed. The incoming data specification seems malformed"
}
},
"summary": "Creates a new yadage workflow from a remote repository."
}
},
"/api/yadage/spec": {
"post": {
"consumes": [
"application/json"
],
"description": "This resource is expecting a JSON yadage specification.",
"operationId": "run_yadage_workflow_from_spec",
"parameters": [
{
"description": "Required. UUID of workflow owner.",
"in": "query",
"name": "user",
"required": true,
"type": "string"
},
{
"description": "JSON object including workflow parameters and workflow specification in JSON format (`yadageschemas.load()` output) with necessary data to instantiate a yadage workflow.",
"in": "body",
"name": "workflow",
"required": true,
"schema": {
"properties": {
"parameters": {
"description": "Workflow parameters.",
"type": "object"
},
"workflow_spec": {
"description": "Yadage specification in JSON format.",
"type": "object"
}
},
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Request succeeded. The workflow has been instantiated.",
"examples": {
"application/json": {
"message": "Workflow successfully launched",
"workflow_id": "cdcf48b1-c2f3-4693-8230-b066e088c6ac",
"workflow_name": "mytest-1"
}
},
"schema": {
"properties": {
"message": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"workflow_name": {
"type": "string"
}
},
"type": "object"
}
},
"400": {
"description": "Request failed. The incoming data specification seems malformed"
}
},
"summary": "Creates a new yadage workflow from a specification file."
}
}
},
"swagger": "2.0",
Expand Down
Loading

0 comments on commit c0a1019

Please sign in to comment.