From 70f348bf9995fd1f7450fbcf7ae6cd8255479505 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Boisvert?= Date: Thu, 5 Jun 2014 19:50:06 +0000 Subject: [PATCH] add a draft for the REST interface MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Link: https://github.com/kbase/assembly/issues/29 Link: https://github.com/kbase/assembly/issues/6 Signed-off-by: Sébastien Boisvert --- README.md | 1 + REST_API.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 REST_API.md diff --git a/README.md b/README.md index 80c5c55..d3dffb6 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This is a service to assemble genomes and metagenomes with user's choice of asse software. It currently supports more than 20 assemblers and processing modules. +[REST API](REST_API.md) Deploying and Testing AssemblyRAST client on KBase infrastructure ---------- diff --git a/REST_API.md b/REST_API.md new file mode 100644 index 0000000..d954729 --- /dev/null +++ b/REST_API.md @@ -0,0 +1,49 @@ +# Summary + +The KBase Assembly Service REST interface returns JSON messages. + +# Job + +## Get one job + +/user/{user.id}/job/{?report} + +## Status of a job + +/user/{user.id}/job/{job.id}/status + +## File info for all results of a job + +/user/{user.id}/job/{job.id}/results{?type,tags} + +# User + +## user's data info + +/user/{user.id}/data +/user/{user.id}/data/{data.id} + +# Apps + +## Modules available for pipeline + +/module/all +/module/avail + +example: http://140.221.84.124:8000/module/avail + +# Blob storage + +## Get Shock host URL + +/shock + +example: http://140.221.84.124:8000/shock + +## More on shock + +- Assembly service uses Shock as its blob storage appliance +- see https://github.com/MG-RAST/Shock +- see https://github.com/MG-RAST/Shock/wiki/API + +example: http://140.221.84.205:8000/node/7373a98f-9135-4b91-85f9-2bb840444436?download