Improving tutorials, examples, documentation

HexmosTech · Jul 22, 2023 · cfe3773 · cfe3773
1 parent cf75f06
commit cfe3773
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 0 deletions.
diff --git a/docs/Lama2/docs/tutorials/examples.md b/docs/Lama2/docs/tutorials/examples.md
@@ -85,6 +85,10 @@ export LOCAL="http://localhost:8000"
 export REMOTE="http://httpbin.org"
 ```
 
+![l2.env at API level](l2env.png)
+
+Get [Source File](https://github.com/HexmosTech/Lama2/tree/main/examples/0023_l2env_declare)
+
 ### Case 2: Root variables
 
 In Lama2, you can have a large number of API files stored in a hierarchical folder configuration.
@@ -97,11 +101,17 @@ Within such a structure, you can have an API file anywhere, which can use variab
 export LOCAL="http://localhost:8000"
 export REMOTE="http://httpbin.org"
 ```
+![l2config.env at Project root level](l2configAtRoot.png)
+
+Get [Source File](https://github.com/HexmosTech/Lama2/tree/main/examples/0022_l2config_declare)
 
 ### Case 3: Override Root variable with local variable
 
+In this structure, if a variable is declared in both l2config.env and l2.env, the value from l2.env takes precedence.
 ![Override of l2config.env with l2.env variable](l2envOverideL2config.png)
 
+Get [Source File](https://github.com/HexmosTech/Lama2/tree/main/examples/0020_override_project_root_local)
+
 ## Headers
 
 Use `key:value` format to specify headers.

diff --git a/docs/Lama2/docs/tutorials/installation.md b/docs/Lama2/docs/tutorials/installation.md
@@ -90,6 +90,7 @@ Application Options:
   -o, --output=      Path to output JSON file to store logs, headers and result
   -v, --verbose      Show verbose debug information
   -n, --nocolor      Disable color in httpie output
+  -e  --env          Get a JSON of environment variables
   -h, --help         Usage help for Lama2
       --version      Print Lama2 binary version
 

diff --git a/docs/Lama2/docs/tutorials/l2configAtRoot.png b/docs/Lama2/docs/tutorials/l2configAtRoot.png
diff --git a/docs/Lama2/docs/tutorials/l2env.png b/docs/Lama2/docs/tutorials/l2env.png
diff --git a/docs/Lama2/docs/tutorials/l2envOverideL2config.png b/docs/Lama2/docs/tutorials/l2envOverideL2config.png
diff --git a/examples/0022_l2config_declare/api/0022_l2config_declare.l2 b/examples/0022_l2config_declare/api/0022_l2config_declare.l2
@@ -0,0 +1,2 @@
+GET
+${AHOST}/get
diff --git a/examples/0022_l2config_declare/l2config.env b/examples/0022_l2config_declare/l2config.env
@@ -0,0 +1,2 @@
+export AHOST=`echo NO URL`
+export BHOST="https://httpbin.org"
diff --git a/examples/0023_l2env_declare/0023_l2env_declare.l2 b/examples/0023_l2env_declare/0023_l2env_declare.l2
@@ -0,0 +1,2 @@
+GET
+${AHOST}/get
diff --git a/examples/0023_l2env_declare/l2.env b/examples/0023_l2env_declare/l2.env
@@ -0,0 +1 @@
+export AHOST=`echo http://httpbin.org`