Merge pull request #197 from lamoda/update-readme

Update doc with "description" field
lamoda · Jan 14, 2023 · 89d4ea3 · 89d4ea3
2 parents 53a1c84 + b0f1f06
commit 89d4ea3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README-ru.md b/README-ru.md
@@ -331,6 +331,7 @@ responseHeaders:
 В описании теста можно использовать переменные, они поддерживаются в следующих полях:
 
 - method
+- description
 - path
 - query
 - headers
@@ -346,6 +347,7 @@ responseHeaders:
 
 ```yaml
 - method: "{{ $method }}"
+  description: "{{ $description }}"
   path: "/some/path/{{ $pathPart }}"
   query: "{{ $query }}"
   headers:
@@ -1804,4 +1806,4 @@ Example:
 ```
 
 В примере выше, схема из файла C:\Users\Leo\gonkey.json будет применяться ко всем файлам 
-с расширением .gonkey.yaml
+с расширением .gonkey.yaml
diff --git a/gonkey.json b/gonkey.json
@@ -18,6 +18,10 @@
           "type": "string",
           "description": "test name"
         },
+        "description":{
+          "type": "string",
+          "description": "test description"
+        },
         "method": {
           "type": "string",
           "description": "HTTP request type",
@@ -548,4 +552,4 @@
       ]
     }
   }
-}
+}