Merge pull request #49 from chkware/release/ready-v0.4.0

Release/ready v0.4.0

Author: 0hsn

docs/02-setup.md

@@ -1,5 +1,5 @@
 ---
-title: Http spec. examples
+title: Http examples
 ---
 
 :::note
@@ -8,11 +8,10 @@ title: Http spec. examples
 :::
 
 :::note
-Case-wise more example can be found in `tests/resources/storage/sample_config` directory of [https://github.com/chkware/cli](https://github.com/chkware/cli/tree/main/tests/resources/storage/sample_config) repository
+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) repository
 :::
 
-
-## Request examples
+[Http specification document reference](/references/http-reference)
 
 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.
 
@@ -255,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/05-References/050-concepts.md

@@ -0,0 +1,49 @@
+---
+title: Testcase 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/blob/main/tests/resources/storage/sample_config/bitcoin-usd-testcase.chk) repository
+:::
+
+[Testcase specification document reference](/references/testcase-reference)
+
+Testcase is an experimental feature, in _`PRE_ALPHA`_ stage.
+
+### Testcase with in-file request
+
+```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}
+```
+
+Assertion [reference with examples](/references/testcase-reference#assertions) can be found here.