docs: Introduce TRIP_SURVEY_SUBDOMAIN config param

ibi-group · Nov 1, 2024 · de1d9f4 · de1d9f4
1 parent 2065188
commit de1d9f4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -301,6 +301,7 @@ The special E2E client settings should be defined in `env.yml`:
 | TRIP_INSTRUCTION_IMMEDIATE_RADIUS | integer | Optional | 2 | The radius in meters under which an immediate instruction is given. |
 | TRIP_INSTRUCTION_UPCOMING_RADIUS | integer | Optional | 10 | The radius in meters under which an upcoming instruction is given. |
 | TRIP_SURVEY_ID | string | Optional | abcdef123y | The ID of a survey (on the platform of your choice) for trip-related feedback. |
+| TRIP_SURVEY_SUBDOMAIN | string | Optional | abcabc12a | The subdomain of a website where the trip-related surveys are administered. |
 | TWILIO_ACCOUNT_SID | string | Optional | your-account-sid | Twilio settings available at: https://twilio.com/user/account |
 | TWILIO_AUTH_TOKEN | string | Optional | your-auth-token | Twilio settings available at: https://twilio.com/user/account |
 | US_RIDE_GWINNETT_BUS_OPERATOR_NOTIFIER_API_URL | string | Optional | http://host.example.com | US RideGwinnett bus notifier API. |

diff --git a/configurations/default/env.yml.tmp b/configurations/default/env.yml.tmp
@@ -100,8 +100,9 @@ TRIP_INSTRUCTION_IMMEDIATE_RADIUS: 2
 # The radius in meters under which an upcoming instruction is given.
 TRIP_INSTRUCTION_UPCOMING_RADIUS: 10
 
-# Survey ID that is linked to a particular trip.
+# Survey ID and domain that is offered after users complete certain trips.
 TRIP_SURVEY_ID: abcdef123y
+TRIP_SURVEY_SUBDOMAIN: abcabc12a
 
 US_RIDE_GWINNETT_BUS_OPERATOR_NOTIFIER_API_URL: https://bus.notifier.example.com
 US_RIDE_GWINNETT_BUS_OPERATOR_NOTIFIER_API_KEY: your-key

diff --git a/src/main/resources/env.schema.json b/src/main/resources/env.schema.json
@@ -324,6 +324,11 @@
       "examples": ["abcdef123y"],
       "description": "The ID of a survey (on the platform of your choice) for trip-related feedback."
     },
+    "TRIP_SURVEY_SUBDOMAIN": {
+      "type": "string",
+      "examples": ["abcabc12a"],
+      "description": "The subdomain of a website where the trip-related surveys are administered."
+    },
     "TWILIO_ACCOUNT_SID": {
       "type": "string",
       "examples": ["your-account-sid"],