Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update docs to include latest features #35

Merged
merged 1 commit into from
Aug 14, 2023
Merged

feat: update docs to include latest features #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api/mock/interaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ An **interaction** adds behavior to the mock server.
| request.path | api path |
| request.pathParams | api path params |
| request.headers | request headers |
| request.cookies | request cookies |
| request.queryParams | query parameters |
| request.body | request body |
| request.graphQL | graphQL details |
Expand All @@ -24,6 +25,7 @@ An **interaction** adds behavior to the mock server.
| response | response details |
| response.status | response status code |
| response.headers | response headers |
| response.cookies | response cookies |
| response.body | response body |
| response.file | path of the file to return |
| response.fixedDelay | delays the response by ms |
Expand Down
4 changes: 3 additions & 1 deletion docs/api/requests/returns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ If the `path` starts with one of the value, it has a special meaning
| `req.pathParams` | Request path params |
| `req.queryParams` | Request query params |
| `req.headers` | Request headers |
| `req.cookies` | Request cookies |
| `res.body` | Response body *(this is default)* |
| `res.headers` | Response headers |
| `res.headers` | Response headers |
| `res.cookies` | Response cookies |

#### > custom_function (function)

Expand Down
4 changes: 3 additions & 1 deletion docs/api/requests/stores.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,10 @@ If the `path` starts with one of the value, it has a special meaning
| `req.pathParams` | Request path params |
| `req.queryParams` | Request query params |
| `req.headers` | Request headers |
| `req.cookies` | Request cookies |
| `res.body` | Response body *(this is default)* |
| `res.headers` | Response headers |
| `res.headers` | Response headers |
| `res.cookies` | Response cookies |

#### > handler_name (string)

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/data-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,10 @@ If the `json-query` starts with one of the value, it has a special meaning
| `req.pathParams` | Request path params |
| `req.queryParams` | Request query params |
| `req.headers` | Request headers |
| `req.cookies` | Request cookies |
| `res.body` | Response body *(this is default)* |
| `res.headers` | Response headers |
| `res.headers` | Response headers |
| `res.cookies` | Response cookies |

## Loading Data

Expand Down
1 change: 1 addition & 0 deletions docs/guides/mock-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ For capturing other parts of the request,
- `req.pathParams` - Request Path Params
- `req.queryParams` - Request Query Params
- `req.headers` - Request Headers
- `req.cookies` - Request cookies
- `req.body` - Request Body


Expand Down