From 033acf9b38bf9710e8a433fed771e3fe2de615f5 Mon Sep 17 00:00:00 2001
From: Mike McLean <mikem@redhat.com>
Date: Wed, 20 Oct 2021 13:25:48 -0400
Subject: [PATCH] clarify id in readme

Fixes https://pagure.io/fm-orchestrator/issue/1723
---
 README.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 75249dcc..7b2d3c65 100644
--- a/README.rst
+++ b/README.rst
@@ -107,7 +107,8 @@ Module submission is done via posting the modulemd SCM URL.
         "branch": "master"
     }
 
-The response, in case of a successful submission, would include the task ID.
+If successful, the response will be the extended json representation of the new module entry.
+This json dictionary will include the module build ID in the "id" field.
 
 ::
 
@@ -117,7 +118,8 @@ The response, in case of a successful submission, would include the task ID.
 
     {
         "id": 42,
-        "state": "wait",
+        "state": 0,
+        "state_name": "init",
         ...
     }