Improve inline documentation of OAUTH_BASE_URL Issue OpenBankProject#54

chrisjsimpson · May 17, 2019 · f96c016 · f96c016
1 parent 0de1b0d
commit f96c016
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/apitester/apitester/settings.py b/apitester/apitester/settings.py
@@ -213,4 +213,11 @@
 # Settings here might use parts overwritten in local settings
 API_ROOT = API_HOST + API_BASE_PATH + API_VERSION
 
-#OAUTH_BASE_URL='https://apisandbox.openbankproject.com'
+''' 
+OAUTH_BASE_URL should be the url of this appliation. It is used by API_HOST
+as the return url. API_HOST is the hostname & scheme of the Open Bank API.
+When API Tester (this application) tries to authenticate with Open Bank API
+during oauth1 flow, it sends the OAUTH_BASE_URL along with it which is 
+used as the redirect url back to this application.
+'''
+#OAUTH_BASE_URL='https://api-tester.example.com'