From 01e868b9df1ed567f1684a9f3f7ad30c3dcdafa0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0abata?= Date: Tue, 21 Jun 2016 16:38:41 +0200 Subject: [PATCH] README: Reword some API paragraphs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Petr Šabata --- README.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index cefb6cec..ac460a43 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ Client-side API =============== The orchestrator implements a RESTful interface for module build submission and -state querying. +state querying. Not all REST methods are supported. See below for details. Module build submission ----------------------- @@ -57,8 +57,8 @@ build task's URL. Querying the BPO service might be preferred, however. GET /rida/module-builds/42 -The response, if the tasks exists, would include various pieces of information -about the build task. +The response, if the task exists, would include various pieces of information +about the referenced build task. :: @@ -75,10 +75,11 @@ about the build task. } } -"id" is the ID of the task. "state" refers to the module build state and might -be one of "init", "building", "done", "failed" or "locked". "tasks" is a -dictionary of component names in the format of "type/NVR" and related koji -tasks and their states. +"id" is the ID of the task. "state" refers to the orchestrator module +build state and might be one of "init", "building", "done", "failed" or +"locked". "tasks" is a dictionary of component names in the format of +"type/NVR" and related koji or other supported buildsystem tasks and +their states. Listing all module builds -------------------------