Skip to content

docs: add FILTERS.md server-side filter reference#41

Merged
Fivell merged 1 commit into
mainfrom
docs/server-filter-reference
May 9, 2026
Merged

docs: add FILTERS.md server-side filter reference#41
Fivell merged 1 commit into
mainfrom
docs/server-filter-reference

Conversation

@Fivell
Copy link
Copy Markdown
Member

@Fivell Fivell commented May 8, 2026

Summary

  • Adds top-level FILTERS.md listing every filter[KEY] query parameter accepted by each list endpoint at API version 2026-04-16.
  • This SDK passes filters through as an untyped string map; until now users had to read Postman or trial-and-error to discover valid keys. The new doc makes the canonical list discoverable inside the repo.
  • Documentation-only — no SDK code touched, no behavior change.

Test plan

  • Every documented filter[KEY] was probed live against https://sandbox-api.didww.com with x-didww-api-version: 2026-04-16 — all 161 keys accepted (no Filter not allowed from the server).
  • FILTERS.md body is byte-identical across all 7 DIDWW SDK repos (only the in-text usage example differs per language).

@Fivell Fivell force-pushed the docs/server-filter-reference branch from c90fa30 to 7c8e110 Compare May 8, 2026 22:41
Document every `filter[KEY]` query parameter accepted by each list endpoint
at API version 2026-04-16. The SDK passes filters through as an untyped
string map, so users currently have to read Postman or trial-and-error to
discover valid keys; this file makes the canonical list discoverable in the
SDK repo itself, and is linked from the README near the existing filter
usage examples.

Every entry was verified live against the DIDWW API at version 2026-04-16.

Documentation-only — no code changes, no behavior change.
@Fivell Fivell force-pushed the docs/server-filter-reference branch from 7c8e110 to de26cf5 Compare May 9, 2026 14:23
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 9, 2026

@Fivell Fivell merged commit 8657dbf into main May 9, 2026
13 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.

1 participant