From d5b39f35f61c652b0fa4e4aa98f5f6a9de15053e Mon Sep 17 00:00:00 2001
From: jay brown <jay.a.brown@gmail.com>
Date: Tue, 8 Apr 2025 12:45:01 -0700
Subject: [PATCH] comments

---
 pkg/queryAPI/readme.md      | 3 +++
 scripts/openapi-scripts.yml | 2 ++
 2 files changed, 5 insertions(+)
 create mode 100644 pkg/queryAPI/readme.md

diff --git a/pkg/queryAPI/readme.md b/pkg/queryAPI/readme.md
new file mode 100644
index 00000000..3e87b4e7
--- /dev/null
+++ b/pkg/queryAPI/readme.md
@@ -0,0 +1,3 @@
+# Client API
+
+This package provides a public client API for the query API.
diff --git a/scripts/openapi-scripts.yml b/scripts/openapi-scripts.yml
index c40193c4..86576423 100644
--- a/scripts/openapi-scripts.yml
+++ b/scripts/openapi-scripts.yml
@@ -25,6 +25,8 @@ tasks:
           $3
       }
 
+      # Below3 the gererateGo for ./pkg is the public client package
+      # and ./api is the internal server package
       for file in serviceAPIs/*.yml serviceAPIs/*.yaml; do
         if [[ -f "$file" ]]; then
           service=$(basename "$file")