Skip to content

Commit af9ef58

Browse files
committed
feature: description and remove body[none]
closes: #24
1 parent 9d706af commit af9ef58

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

docs/05-reference.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,15 @@ This page describes some key concepts before you use **chkware**. There are two
1919

2020
Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any
2121
specs, you should have a proper introduction to YAML, if you do not have already. Here is a fine
22-
[YAML cheatsheet](https://quickref.me/yaml) to grasp some knowledge.We are using this specific extension (`.chk`) so these files do not
23-
make you confuse in typical project layout.
22+
[YAML cheatsheet](https://quickref.me/yaml) to grasp some knowledge. We are using this specific extension (`.chk`)
23+
so these files do not make you confuse in typical project layout.
2424

25-
> In the future evolution path of **chkware** we are going to introduce more and more specification options and specification types and versions.
25+
> In the future evolution path of **chkware** we are going to introduce more and more specification
26+
> options and specification types and versions.
2627
27-
Let’s first get you introduced to the (till now) only specification format supported by **chkware**, the Http specification format. As mentioned in the introduction page **_Create reusable offline http request specification._**, the Http specification format is how you express a Http request format. Following are some examples by case to write Http specification file.
28-
29-
---
30-
31-
Following yaml blocks can be used to identify different section of a Http specification file.
28+
Let’s get introduced to the Http specification format supported by **chkware**. The Http specification
29+
format is how anyone express a Http request. Following is the full reference to write
30+
Http specification file.
3231

3332
```yaml
3433
---
@@ -66,9 +65,6 @@ request:
6665

6766
# send request body with the request
6867

69-
# no body to send
70-
body[none]: ~
71-
7268
# to send application/x-www-form-urlencoded form enctype
7369
body[form]:
7470
'var 1': 'var str 1'

0 commit comments

Comments
 (0)