Skip to content

docs: Document header validation enforcement and OpenAPI context propagation #109

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document header validation enforcement and OpenAPI context propagation #109

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: 1 addition & 1 deletion docs/get-started/actions/httpRequest.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can specify a basic GET request using a string shorthand or use an object fo
- `parameters`: (Optional) Key-value pairs for query string parameters.
- `body`: (Optional) The request body. Can be a string or JSON object.
- `response`: (Optional) An object defining expected response validation:
- `headers`: (Optional) Key-value pairs for expected response headers. Values must be strings.
- `headers`: (Optional) Key-value pairs for expected response headers. Values must be strings. If specified, the step fails if any expected header is missing or has a different value in the actual response.
- `body`: (Optional) Expected response body. Can be a string or JSON object.
- `statusCodes`: (Optional) An array of acceptable HTTP status codes. If the response code is not in this list, the step fails (default: `[200]`).
- `openApi`: (Optional) Define the request based on an OpenAPI definition. Can be a string (operation ID) or an object:
Expand Down
2 changes: 1 addition & 1 deletion docs/references/schemas/integrations-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Options for connecting to external services.

Field | Type | Description | Default
:-- | :-- | :-- | :--
openApi | array of unknown | Optional. No description provided. |
openApi | array of [openApi](/docs/references/schemas/openApi) | Optional. OpenAPI definitions to load. These are automatically made available in test contexts, letting `httpRequest` actions reference them by `operationId` or `name`. See the [openApi](/docs/references/schemas/openApi) schema for details. |

## Examples

Expand Down
Loading