Merge pull request #22 from jpodivin/readmefix

Putting README.md in sync with the code

Author: jpodivin

README.md

@@ -1,10 +1,10 @@
-# logdetective-packit 
+# logdetective-packit
 
 [![Run pytest](https://github.com/fedora-copr/logdetective-packit/actions/workflows/pytest.yml/badge.svg)](https://github.com/fedora-copr/logdetective-packit/actions/workflows/pytest.yml) [![Container Image Build and Publish](https://github.com/fedora-copr/logdetective-packit/actions/workflows/image_publish.yml/badge.svg)](https://github.com/fedora-copr/logdetective-packit/actions/workflows/image_publish.yml)
 
 Server providing interface between [Packit](https://packit.dev/) and [Log Detective](https://github.com/fedora-copr/logdetective) using [Fedora
 messaging infrastructure](https://docs.fedoraproject.org/en-US/infra/developer_guide/messaging/).
- 
+
 Requests sent to `/analyze` enpoint are routed to Log Detective server
 with URL set by `LD_URL` environment variable. Eventual response is
 posted on the public fedora messaging under `logdetective.analysis` topic,
@@ -18,16 +18,32 @@ The endpoint expects a JSON payload matching the `BuildInfo` model:
 ```
 {
   "logs": {
-    "builder-live.log": "http://example.com/logs/123/builder-live.log",
+    "builder-live.log": "http://example.com/builder-live.log",
     "backend.log": "http://example.com/logs/123/backend.log"
   },
-  "build_id": "12345"
+  "target_build": "12345",
+  "build_system": "copr",
+  "commit_sha": "9deb98c730bb4123f518ca13a0dbec5d7c0669ca",
+  "project_url": "www.logdetective.com",
+  "pr_id": 1
 }
 ```
 
 logs (dict): A dictionary mapping log filenames to their full URL.
 
-build_id (str): A unique identifier for the build, which will be included in the message.
+target_build (str): A unique identifier for the build, which will be included in the message.
+
+build_system (str): Name of the build system used, in practice either `copr` or `koji`
+
+commit_sha (str): Hash of the commit from which the build was created
+
+project_url (str): URL of the project the build is for
+
+pr_id (int): Identifier of the pull request, or equivalent
+
+Of these values, only `logs` are used by Log Detective itself.
+The rest is used as part of a message sent to Fedora Messaging infrastructure,
+to identify results.
 
 ## Run the container
 
@@ -43,7 +59,7 @@ and then run the container:
 ```
 podman run -d --name logdetective-packit \
   -p 8090:8090 \
-  -e LD_URL="https.logdetective.example.com/api" \
+  -e LD_URL="https://logdetective.example.com/api" \
   logdetective-packit:latest
 ```