DSLModule

Marks an interpolated URL value for diagnostic redaction. <example><code>GET $"https://api.example.com/users?key={secret apiKey}"</code></example>

Creates a GET request from an interpolated URL. Every hole is URL-encoded as one value. <example><code>GET $"https://api.example.com/users/{userId}"</code></example>

Creates a HEAD request from an interpolated URL with encoded holes.

Creates a POST request from an interpolated URL with encoded holes. <example><code>POST $"https://api.example.com/users" |&gt; jsonBody payload</code></example>

Creates a PUT request from an interpolated URL with encoded holes.

Creates a PATCH request from an interpolated URL with encoded holes.

Creates a DELETE request from an interpolated URL with encoded holes.

Appends a URL-encoded query parameter. <example><code>GET $"{root}/search" |&gt; query "q" term</code></example>

Appends a redacted query parameter. <example><code>request |&gt; secretQuery "api_key" key</code></example>

Appends one request header. <example><code>request |&gt; header "Accept" "text/csv"</code></example>

Adds a redacted bearer-token Authorization header. <example><code>request |&gt; bearer token</code></example>

Adds a redacted basic-auth Authorization header. <example><code>request |&gt; basicAuth user password</code></example>

Sets a per-request timeout. <example><code>request |&gt; timeout (TimeSpan.FromSeconds 5.0)</code></example>

Sends an already-serialized JSON body. <example><code>request |&gt; jsonBody """{"name":"Ada"}"""</code></example>

Encodes and sends a JSON body. <example><code>request |&gt; jsonBodyOf (Json.serialize codec) user</code></example>

Sends a plain-text body. <example><code>request |&gt; textBody "hello"</code></example>

Sends URL-encoded form fields. <example><code>request |&gt; formBody [ "q", "axial" ]</code></example>

Replaces the statuses treated as success. <example><code>request |&gt; expect [ 200; 404 ]</code></example>

Treats every status as success. <example><code>request |&gt; expectAny</code></example>

Sends the request and returns the full transcript, failing on unexpected statuses. <example><code>GET $"{root}/users" |&gt; fetch</code></example>

Sends the request and returns the body text. <example><code>GET $"{root}/readme" |&gt; fetchText</code></example>

Sends the request and returns the body bytes. <example><code>GET $"{root}/logo.png" |&gt; fetchBytes</code></example>

Sends the request and decodes the JSON response. <example><code>GET $"{root}/users/{id}" |&gt; fetchJson (Json.deserializeResult codec)</code></example>

Retries transient failures with exponential backoff. <example><code>GET $"{root}/users" |&gt; fetchJson decode |&gt; withRetries 4</code></example>