Skip to content

docs: document X-Trickster-Result header#1055

Merged
jranson merged 1 commit into
trickstercache:mainfrom
houyuwushang:docs-trickster-result-492
Jul 9, 2026
Merged

docs: document X-Trickster-Result header#1055
jranson merged 1 commit into
trickstercache:mainfrom
houyuwushang:docs-trickster-result-492

Conversation

@houyuwushang

Copy link
Copy Markdown
Contributor

Description

Related to #492.

Adds a dedicated X-Trickster-Result documentation page covering:

  • the header field format (engine, status, fetched, ffstatus, failed);
  • cache/result status meanings, including proxy-only;
  • common reasons a request can be proxied without cache use;
  • Fast Forward status values.

Also links the cache status reference to the new page and fills in status values that exist in code but were missing from the docs table.

Validation:

  • go test ./pkg/proxy/headers ./pkg/cache/status -count=1
  • git diff --check

Type of Change

    • Bug fix
    • New feature
    • Optimization
    • Test coverage
    • Documentation
    • Infrastructure

AI Disclosure

    • This contribution DOES NOT include AI-generated changes
    • This contribution DOES include AI-generated changes, and I have reviewed the relevant contributing guidelines.

Signed-off-by: houyuwushang <liuluoqianqiu@outlook.com>
@houyuwushang houyuwushang requested a review from a team as a code owner July 9, 2026 03:28
@jranson jranson merged commit af01a26 into trickstercache:main Jul 9, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants