update documentation for example-level variables

sunny-chung · Nov 10, 2024 · 71da36c · 71da36c
1 parent 3b6dc06
commit 71da36c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -155,7 +155,6 @@ express your desired priorities in the issue tracker.
 - Binary response view
 - Binary request editor
 - Overriding default headers
-- Example-level variables
 - Checking for version updates
 - Establish release builds (minified and without debug logs and symbols)
 

diff --git a/doc/_include/variables.png b/doc/_include/variables.png
diff --git a/doc/features/request-examples-and-payload-examples.md b/doc/features/request-examples-and-payload-examples.md
@@ -25,6 +25,16 @@ Body with content type "None" or "Binary File" cannot be inherited.
 Body with remaining content types can be changed to inherit from the Base Example, by unselecting the
 "Is Override Base?" checkbox.
 
+### Variables
+
+Variables can be defined in Request Example level to override [Environment Variables](environments). Variables defined in the Base Example are inherited and can be overridden.
+
+Similar to Environment Variables, variables can be used anywhere in the request with the syntax `${{variable-name}}`.
+
+Overridden variables are displayed in a dimmed color.
+
+![Example-level Variables](../variables.png)
+
 ### Other Stuffs
 
 By default, following items are inherited from the "Base Example" of the same Request.