Merge pull request #224 from blagerweij/chore/update-formdata-docs

chore: update multipart syntax
stepci · Jun 10, 2024 · 97e7873 · 97e7873
2 parents 7f1f808 + f152f16
commit 97e7873
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/docs/guides/testing-http.md b/docs/guides/testing-http.md
@@ -174,9 +174,15 @@ Steps are the instructions to be executed by the runner. Steps contain the reque
     url: https://httpbin.org/post
     method: POST
     formData:
-      email: hello@example.com
+      email: hello@example.com      # simple field value
       example:
-        file: file.txt
+        file: file.txt              # file attachment
+      idDocument:
+        file: password.pdf          # file attachment with specific content-type
+        type: application/pdf
+      personInfo:
+        value: '{ "name": "john" }' # form field with specific content-type
+        type: application/json
 ```
 
 ### File uploads

diff --git a/docs/reference/workflow-syntax.md b/docs/reference/workflow-syntax.md
@@ -712,11 +712,19 @@ Fields can include a file
 
 ```yaml
 formData:
-  email: hello@stepci.com
+  email: hello@stepci.com       # simple field value
   readme:
-    file: README.md
+    file: README.md             # file attachment
+  idDocument:
+    file: password.pdf          # file attachment with specific content-type
+    type: application/pdf
+  personInfo:
+    value: '{ "name": "john" }' # form field with specific content-type
+    type: application/json
 ```
 
+
+
 ### `tests.<test>.steps.[step].http.graphql`
 
 Optional. GraphQL Data