Overhaul README configuration docs - #16
Merged
Merged
Conversation
Documents all remaining config options - enabling/disabling, header redaction, response body exclusion and limits, keep_successful_responses, database connection, and pruning - grouped under a single Configuration section with the existing only/ignore and queue docs. Adds a short requirements section and documents the placeholder body values that appear in the barstools table. Also removes a mention of a non-existent UI from the config comment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview of change
Documentation follow-up from #13/#15: the README previously documented queue support and the newer features but almost none of the config options. This PR:
only/ignore), keeping only failed responses, redacting sensitive request headers, excluding response bodies, response body limits, database connection, pruning, and queue supportbarstoolstable (REDACTED,<Streamed Body>,<Multipart Body>,<Unsupported Barstool Response Content>) and when each appearsOne non-README change: the
enabledconfig comment mentioned a UI that doesn't exist, so that mention is removed.Testing
Docs only (plus a config comment) — full suite still green locally (31 passed, 154 assertions), Pint clean.