Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/decisions/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Index of Sendra design decisions: unasserted statuses under test, how exit codes are split, script sandboxing and the precedence chain."
---
# Design decisions

The rationale behind the design choices in Sendra's schema and CLI that could
Expand Down
3 changes: 3 additions & 0 deletions docs/decisions/exit-codes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Why exit code 4 is separate from 3, why an unsendable request under test exits 1, and how the codes rank across a whole collection."
---
# Exit codes: why the numbers are split the way they are

Background: the full table of codes and what each one means is in
Expand Down
3 changes: 3 additions & 0 deletions docs/decisions/precedence-chain.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "The full precedence chain for a request value: defaults, config, environment files, captures, CLI overrides, then pre_request scripts."
---
# Precedence, start to finish

Every layer that can decide a value for a request is introduced in its own
Expand Down
3 changes: 3 additions & 0 deletions docs/decisions/sandboxing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "How pre_request and post_request scripts are kept away from the filesystem and network: nothing registered, no import, no eval, an operation cap."
---
# Sandboxing

Background: what a `pre_request`/`post_request` script can see and do is in
Expand Down
3 changes: 3 additions & 0 deletions docs/decisions/why-test-ignores-unasserted-status.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Why sendra test does not fail a run on an unasserted 404, and why a post_request script counts as a check the same way an assertion does."
---
# Why `test` ignores an unasserted status

Background: the mechanics and the four outcome categories (`passed`, `failed`,
Expand Down
3 changes: 3 additions & 0 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Index of the Sendra reference: request files, assertions, environments, scripting, exit codes, JSON output and the TUI, with a link to each page."
---
# Reference

The full schema and behavior reference for Sendra, split by topic. Start at
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/assertions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Check status, headers, body text and JSON paths with assertions in a request file, plus status_in, regex, timing, negation and comparisons."
---
# Assertions

A request can say what it expects of the response, under an optional
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/capturing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Capture values from a JSON body, header or status with a capture block, then reuse them as variables in later requests to chain calls."
---
# Capturing values and chaining requests

A request can pull values out of its response and hand them to the requests
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/cli-overrides.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Flags for sendra run and test that override files for one invocation: -H, --var, --timeout, --insecure, --proxy, client certificates, --cookie-jar."
---
# CLI overrides

Flags that change one invocation without touching a file, on `sendra run` and
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Set project or global defaults in config.yaml: headers, timeout, redirects, TLS verification, proxy, client certificates and a cookie jar."
---
# Configuration

Defaults that apply to every request live in a config file. There are two, both
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/development.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Build, test, format and lint the Sendra Rust workspace with the five cargo commands CI runs, and why the test suite never touches the network."
---
# Development

```sh
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/environments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Define environment files of variables, use them as {{name}} in requests, keep secrets in OS variables with ${VAR}, and set a default auth."
---
# Environments and variables

An environment is a flat file of variables at
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/exit-codes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "The exit code table for the sendra binary: what 0, 1, 2, 3 and 4 mean under run and test, for shell scripts and CI pipelines."
---
# Exit codes

One table for the whole binary, not one per subcommand: `run` and `test` answer
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/json-output.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "The --json output of sendra run and test: one JSON object per run with responses, assertion results, captures and a test summary."
---
# JSON output

`--json` replaces the terminal output with one JSON object describing the whole
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/json-schema.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Get JSON Schema files for Sendra requests, collections, config and environments, and set up VS Code for autocomplete and validation."
---
# JSON Schema / editor support

`schema/*.schema.json` are [JSON Schema](https://json-schema.org/) documents
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/requests.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "The Sendra request and collection YAML format: fields, repeated headers, and authentication with bearer, basic, API key and OAuth."
---
# Request and collection file shape

## Request file shape
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/running-and-testing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Send requests and collections with sendra run, or check them with sendra test, including output format, result categories and the summary."
---
# Running and testing requests

## Running requests
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/scripting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Write pre_request and post_request scripts in Rhai to change a request or check a response, with what each can see and the run order."
---
# Scripting

A request can carry two inline scripts: `pre_request`, which runs just before it
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/tui.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Use the sendra tui terminal app (TUI) to browse, run and edit requests, switch environments, review run history and find every keybinding."
---
# The interactive TUI

`sendra tui` opens a full-screen terminal app for browsing and running the
Expand Down
Loading