Add comment explaining to temporarily add FIA_API_API key to the spec…

…ification migration script The API key isn't accepted by the terminal due to fancy characters
fiaisis · Aug 13, 2024 · 3ac07cf · 3ac07cf
1 parent 3c118d0
commit 3ac07cf
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tools/specification_migration.py b/tools/specification_migration.py
@@ -12,6 +12,11 @@
 import requests
 
 FIA_API_URL = sys.argv[1]
+"""
+The API key doesn't work when running in a bash terminal (due to the non
+alpha-numeric characters). So it needs to be temporarily added below when running,
+and removed after (DO NOT COMMIT the hardcoded FIA_API_API_KEY)
+"""
 FIA_API_API_KEY = sys.argv[2]
 
 successful_update: int = 200