From 4ea2c4fd8618adc45258c84a32203d4aa916155b Mon Sep 17 00:00:00 2001
From: Joseph Doherty <dohejw01@gmail.com>
Date: Sun, 26 Apr 2026 21:26:28 -0400
Subject: [PATCH] Issue #50: clarify packaging API key placeholders

---
 clients/dotnet/README.md | 2 +-
 clients/go/README.md     | 2 +-
 clients/java/README.md   | 2 +-
 clients/python/README.md | 4 ++--
 clients/rust/README.md   | 2 +-
 docs/ClientPackaging.md  | 4 ++--
 6 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/clients/dotnet/README.md b/clients/dotnet/README.md
index f11cc9e..223746b 100644
--- a/clients/dotnet/README.md
+++ b/clients/dotnet/README.md
@@ -146,7 +146,7 @@ Run live checks only when a gateway and MXAccess-backed worker are available:
 ```powershell
 $env:MXGATEWAY_INTEGRATION = '1'
 $env:MXGATEWAY_ENDPOINT = 'http://localhost:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'Area001.Pump001.Speed'
 dotnet run --project clients/dotnet/MxGateway.Client.Cli -- smoke --endpoint $env:MXGATEWAY_ENDPOINT --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json
 ```
diff --git a/clients/go/README.md b/clients/go/README.md
index cbc2219..4f73d97 100644
--- a/clients/go/README.md
+++ b/clients/go/README.md
@@ -113,7 +113,7 @@ Run live checks only when a gateway and MXAccess-backed worker are available:
 ```powershell
 $env:MXGATEWAY_INTEGRATION = '1'
 $env:MXGATEWAY_ENDPOINT = 'localhost:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'Area001.Tag.Value'
 go run ./cmd/mxgw-go smoke -endpoint $env:MXGATEWAY_ENDPOINT -plaintext -api-key-env MXGATEWAY_API_KEY -item $env:MXGATEWAY_TEST_ITEM -json
 ```
diff --git a/clients/java/README.md b/clients/java/README.md
index 222703c..5bce284 100644
--- a/clients/java/README.md
+++ b/clients/java/README.md
@@ -122,7 +122,7 @@ Run live checks only when a gateway and MXAccess-backed worker are available:
 ```powershell
 $env:MXGATEWAY_INTEGRATION = '1'
 $env:MXGATEWAY_ENDPOINT = 'localhost:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'TestObject.TestInt'
 gradle :mxgateway-cli:run --args="smoke --endpoint $env:MXGATEWAY_ENDPOINT --plaintext --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json"
 ```
diff --git a/clients/python/README.md b/clients/python/README.md
index 10d9035..677e2ec 100644
--- a/clients/python/README.md
+++ b/clients/python/README.md
@@ -78,7 +78,7 @@ from mxgateway import GatewayClient
 
 async with await GatewayClient.connect(
     endpoint="localhost:5000",
-    api_key="mxgw_example",
+    api_key="<gateway-api-key>",
     plaintext=True,
 ) as client:
     session = await client.open_session(client_session_name="python-client")
@@ -141,7 +141,7 @@ Run live checks only when a gateway and MXAccess-backed worker are available:
 ```powershell
 $env:MXGATEWAY_INTEGRATION = '1'
 $env:MXGATEWAY_ENDPOINT = 'localhost:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'Object.Attribute'
 mxgw-py smoke --endpoint $env:MXGATEWAY_ENDPOINT --plaintext --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json
 ```
diff --git a/clients/rust/README.md b/clients/rust/README.md
index 8316002..47eb700 100644
--- a/clients/rust/README.md
+++ b/clients/rust/README.md
@@ -106,7 +106,7 @@ Run live checks only when a gateway and MXAccess-backed worker are available:
 ```powershell
 $env:MXGATEWAY_INTEGRATION = '1'
 $env:MXGATEWAY_ENDPOINT = 'http://127.0.0.1:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'TestChildObject.TestInt'
 cargo run -p mxgw-cli -- smoke --endpoint $env:MXGATEWAY_ENDPOINT --plaintext --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json
 ```
diff --git a/docs/ClientPackaging.md b/docs/ClientPackaging.md
index fb7c9dd..bf8aec6 100644
--- a/docs/ClientPackaging.md
+++ b/docs/ClientPackaging.md
@@ -25,7 +25,7 @@ The examples use these common variables:
 
 ```powershell
 $env:MXGATEWAY_ENDPOINT = 'localhost:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'TestObject.TestInt'
 ```
 
@@ -237,7 +237,7 @@ environment before running a client smoke:
 ```powershell
 $env:MXGATEWAY_INTEGRATION = '1'
 $env:MXGATEWAY_ENDPOINT = 'localhost:5000'
-$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
 $env:MXGATEWAY_TEST_ITEM = 'TestObject.TestInt'
 $env:MXGATEWAY_TEST_CONTEXT = ''
 $env:MXGATEWAY_TEST_WRITE_VALUE = '123'