Merge pull request #111 from RalphTro/webservice-documentation

added container documentation
RalphTro · Jan 25, 2024 · 8ebb171 · 8ebb171
2 parents e1413be + d1e1abc
commit 8ebb171
Show file tree

Hide file tree

Showing 3 changed files with 0 additions and 60 deletions.
diff --git a/Dockerfile b/Dockerfile
diff --git a/README.md b/README.md
@@ -36,15 +36,6 @@ For usage information run
 python3 -m epcis_event_hash_generator -h
 ```
 
-
-### Web Service
-
-The script also comes wrapped as a web service in a docker image for ease of integration into a testing environment.
-You may use 
-
-- [the latest release version of the web service container](https://github.com/RalphTro/epcis-event-hash-generator/packages/484860 ). See here for usage.
-
-
 ## Introduction  
 There are situations in which organisations require to uniquely refer to a specific EPCIS event. For instance, companies may only want to store the <b>hash value of a given EPCIS event on a distributed shared ledger ('blockchain')</b> instead of any actual payload. Digitally signed and in conjunction with a unique timestamp, this is a powerful and effective way to prove the integrity of the underlying event data. Another use case consists to use such an approach to <b>populate the eventID field with values that are intrinsic to the EPCIS event</b> - if an organisation captures an event without an eventID field (which is not required as of the standard) and sends that event to a business partner who needs to assign a unique ID, they can agree that the business partner populates the `eventID` field applying this methodology before storing the event on the server. If the organisation later wants to query for that specific event, it knows how the eventID was created, thus is able to query for it through the eventID value.
 EPCIS events have a couple of differences to other electronic documents:

diff --git a/webapi/api.py b/webapi/api.py