Redfish rules for use of data/variables.py
Add to redfish coding guidelines documentation.
Change-Id: I7c680207681f5215b3a22553378c22174c28ba48
Signed-off-by: Michael Walsh <micwalsh@us.ibm.com>
diff --git a/docs/redfish_coding_guidelines.md b/docs/redfish_coding_guidelines.md
index 3a8cb89..6646052 100644
--- a/docs/redfish_coding_guidelines.md
+++ b/docs/redfish_coding_guidelines.md
@@ -118,3 +118,33 @@
username, etc.).
- Any keyword or test case which breaks the above rules is responsible for
setting things right (i.e. back to a logged in state).
+
+Rules for use of data/variables.py
+==================================
+
+Avoid defining variables in data/variables.py for Redfish URIs.
+
+There's no obvious benefit to using such variables. Conversely, with literal values,
+it is much easier for the programmer to interpret the code.
+
+Consider the following example.
+
+Here's an excerpt from data/variables.py:
+
+```
+# Redfish variables.
+REDFISH_BASE_URI = '/redfish/v1/'
+...
+REDFISH_ACCOUNTS = 'AccountService/Accounts/'
+REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
+```
+
+And here is a corresponding Robot code example:
+
+```
+ # Rather than coding this:
+ Redfish.Delete ${REDFISH_ACCOUNTS_URI}user_user
+
+ # Code this:
+ Redfish.Delete /redfish/v1/AccountService/Accounts/user_user
+```