add variable example doc

- move existing variable docs from http to variables example
- document format update
- links update
- sidebar entry for variable examples

Author: 0hsn

docs/examples/http-examples.md

@@ -13,8 +13,6 @@ Case-wise more example can be found in [https://github.com/chkware/cli](https://
 
 [Http specification document reference](/references/http-reference)
 
-## Request examples
-
 Following examples are using HTTP _GET_ and _POST_ method. Although all these example are still valid for _POST_, _PUT_, _PATCH_, _DELETE_, _OPTIONS_, _HEAD_ method as well. You can still send a request body with _GET_ or _HEAD_ method for the sake of testing API.
 
 ### Minimal request with HTTP GET method
@@ -256,54 +254,3 @@ request:
       </book>
     </catalog>
 ```
-
----
-## Request using variable examples
-
-We can also use variables inside a http specification file. See examples below. 
-
-** * This is highly experimental. Report any bug you can find.**
-
-### Request with query string using variables
-
-```yaml
----
-version: default:http:0.7.2
-
-# define local variables
-variables:
-  Foo: 'bar'
-  Two: 2
-  Server: https://example.org/api
-
-request:
-  # put variables on the path for query string
-  url: {$Server}/path?foo={$Foo}&two={$Two}
-  method: GET
-```
-
-### Request with basic authentication header using variables
-
-```yaml
----
-version: default:http:0.7.2
-
-# define local variables
-variables:
-  userName: Some_USER
-  password: Some-P@$$W03D
-  content_type: application/json
-  Server: https://example.org/api
-
-request:
-  url: {$Server}/resource/id
-  method: GET
-
-  headers:
-    Accept-Encoding: gzip, deflate
-    Content-Type: {$content_type}
-
-  auth[basic]:
-    username: {$userName}
-    password: {$password}
-```

docs/examples/testcase-examples.md

@@ -13,11 +13,8 @@ Case-wise more example can be found in [https://github.com/chkware/cli](https://
 
 [Testcase specification document reference](/references/testcase-reference)
 
-## Testcase examples:
-
 Testcase is an experimental feature, in _`PRE_ALPHA`_ stage.
 
-
 ### Testcase with in-file request
 
 ```yaml

docs/examples/variable-examples.md

@@ -0,0 +1,96 @@
+---
+title: Variable examples
+---
+
+:::note
+- This page should be use as reference for specification files.
+- This page is subject to change. It is requested to check this page frequently.
+:::
+
+:::note
+Case-wise more example can be found in [https://github.com/chkware/cli](https://github.com/chkware/cli/tree/main/tests/resources/storage/sample_config/pass_cases/variables) repository
+:::
+
+[Variable specification document reference](/references/variable-reference)
+
+We can also use variables inside a http and testcase specification file. See examples below. 
+
+** * This is highly experimental. Report any bug you can find.**
+
+### Request with query string using variables
+
+```yaml
+---
+version: default:http:0.7.2
+
+# define local variables
+variables:
+  Foo: 'bar'
+  Two: 2
+  Server: https://example.org/api
+
+request:
+  # put variables on the path for query string
+  url: {$Server}/path?foo={$Foo}&two={$Two}
+  method: GET
+
+```
+
+### Request with basic authentication header using variables
+
+```yaml
+---
+version: default:http:0.7.2
+
+# define local variables
+variables:
+  userName: Some_USER
+  password: Some-P@$$W03D
+  content_type: application/json
+  Server: https://example.org/api
+
+request:
+  url: {$Server}/resource/id
+  method: GET
+
+  headers:
+    Accept-Encoding: gzip, deflate
+    Content-Type: {$content_type}
+
+  auth[basic]:
+    username: {$userName}
+    password: {$password}
+
+```
+
+### Testcase using variables
+
+```yaml
+---
+version: 'default:testcase:0.7.2'
+
+variables:
+  Name: 'Morpheus'
+  Job: 'leader'
+  Response: ~
+  Server: https://reqres.in/api/v1
+
+request:
+  url: "{$Server}/users"
+  method: POST
+  body[json]: {
+    'name': $Name,
+    'job': $Job,
+  }
+  return: ~
+
+spec:
+  execute:
+    file: ~
+    result: $Response
+
+  asserts:
+    - {type: AssertEqual, actual: $Response.code, expected: 201}
+    - {type: AssertIsMap, actual: $Response.body}
+
+```

docs/references/variable-reference.md

@@ -28,5 +28,5 @@ Variables can be defined in two ways:
 
 ### Supported specification document
 
-- [Http specification document examples](/examples/http-examples#variable-examples) | [More example](https://github.com/chkware/cli/tree/0272b83c2975349fd3f0d94e1646cc27b603eaf5/tests/resources/storage/sample_config/pass_cases/variables)
-- [Testcase specification document examples](/examples/testcase-examples) | [More example](https://github.com/chkware/cli/tree/890c2a6c11c5b16be4678ac27083befa1ef0986c/tests/resources/storage/sample_config/pass_cases/UserCreate)
+- [Http specification document examples](/examples/http-examples#variable-examples) | [More example](https://github.com/chkware/cli/tree/main/tests/resources/storage/sample_config/pass_cases/variables)
+- [Testcase specification document examples](/examples/testcase-examples) | [More example](https://github.com/chkware/cli/tree/main/tests/resources/storage/sample_config/pass_cases/UserCreate)

sidebars.js

@@ -25,6 +25,7 @@ const sidebars = {
       items: [
         'examples/http-examples',
         'examples/testcase-examples',
+        'examples/variable-examples',
       ],
     },
     {