Skip to content

Commit

Permalink
document body option
Browse files Browse the repository at this point in the history
  • Loading branch information
leggsimon committed Sep 10, 2019
1 parent f4b7892 commit 996c2fe
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/_api-mocking/mock_options.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "options"
title: 'options'
position: 1.3
description: |-
An object containing further options for configuring mocking behaviour
Expand Down Expand Up @@ -28,23 +28,32 @@ parameters:
- Headers
content: |-
Match only requests that have these headers set
examples:
examples:
- |-
{"Accepts": "text/html"}
- name: body
types:
- Object
- Headers
content: |-
Match only requests that have this body (requires a `Content-Type` request header to be set to `application/json`)
examples:
- |-
{"JSON": "body"}
- name: query
types:
- Object
content: |-
Match only requests that have these query parameters set (in any order)
examples:
examples:
- |-
{"q": "cute+kittenz", "format": "gif"}
- name: params
types:
- Object
content: |-
When the `express:` keyword is used in a string matcher, match only requests with these express parameters
examples:
examples:
- |-
{"section": "feed", "user": "geoff"}
- name: functionMatcher
Expand Down

0 comments on commit 996c2fe

Please sign in to comment.