feat: Env now has ESS prefix (was WS)

Author: Alan Christie

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 ---
-minimum_pre_commit_version: 4.0.0
+minimum_pre_commit_version: 3.8.0
 
 repos:
 

README.md

@@ -24,6 +24,7 @@ _public_ web-sockets managed by an _internal_ API, managed by the AS using
 the required endpoint: -
 
     /event-stream POST
+    / event-stream GET
     /event-stream/{id} DELETE
 
 See the AS Event Stream API documentation for more details, and the discussion
@@ -65,14 +66,14 @@ request: -
 
 To create (**POST**) an event stream, run the following:
 
-    ES_LOC=$(http post localhost:8081/event-stream/ routing_key=0123456789 -b | jq -r ".location")
-    echo $ES_LOC
-    ES_ID=$(echo $ES_LOC | cut -d/ -f5)
-    echo $ES_ID
+    ESS_LOC=$(http post localhost:8081/event-stream/ routing_key=0123456789 -b | jq -r ".location")
+    echo $ESS_LOC
+    ESS_ID=$(echo $ESS_LOC | cut -d/ -f5)
+    echo $ESS_ID
 
 To **DELETE** the event stream, run the following:
 
-    http delete localhost:8081/event-stream/$ES_ID -b
+    http delete localhost:8081/event-stream/$ESS_ID -b
 
 To list (**GET**) all the existing event streams, run the following:
 

app/app.py

@@ -30,15 +30,15 @@
 app_internal = FastAPI()
 
 # Configuration...
-_INGRESS_LOCATION: str = os.getenv("WS_INGRESS_LOCATION", "localhost:8080")
-assert _INGRESS_LOCATION, "WS_INGRESS_LOCATION environment variable must be set"
+_INGRESS_LOCATION: str = os.getenv("ESS_INGRESS_LOCATION", "localhost:8080")
+assert _INGRESS_LOCATION, "ESS_INGRESS_LOCATION environment variable must be set"
 _INGRESS_SECURE: bool = os.getenv("WS_INGRESS_SECURE", "no").lower() == "yes"
 _LOGGER.info("INGRESS_LOCATION: %s", _INGRESS_LOCATION)
 _LOGGER.info("INGRESS_SECURE: %s", _INGRESS_SECURE)
 
 _AMPQ_EXCHANGE: str = "event-streams"
-_AMPQ_URL: str = os.getenv("WS_AMPQ_URL", "")
-assert _AMPQ_URL, "WS_AMPQ_URL environment variable must be set"
+_AMPQ_URL: str = os.getenv("ESS_AMPQ_URL", "")
+assert _AMPQ_URL, "ESS_AMPQ_URL environment variable must be set"
 _LOGGER.info("AMPQ_URL: %s", _AMPQ_URL)
 
 # Create our local database.

docker-compose.yml

@@ -23,9 +23,9 @@ services:
     image: informaticsmatters/squonk2-fastapi-ws-event-stream:latest
     container_name: es
     environment:
-      WS_AMPQ_URL: 'amqp://es:cheddar1963@rabbitmq:5672'
-      WS_INGRESS_LOCATION: 'localhost:8080'
-      WS_INGRESS_SECURE: 'no'
+      ESS_AMPQ_URL: 'amqp://es:cheddar1963@rabbitmq:5672'
+      ESS_INGRESS_LOCATION: 'localhost:8080'
+      ESS_INGRESS_SECURE: 'no'
     ports:
     # Public (Websocket)
     - '8080:8080'