Skip to content

README.md

Latest commit

 

History

History
47 lines (37 loc) · 1.78 KB

README.md

File metadata and controls

47 lines (37 loc) · 1.78 KB
Raw

QFV Documentation

Reference documentation for the Query Filters Validator (github.com/slashdevops/qfv).

The three parsers at a glance

flowchart TB
    subgraph inputs["Query-string parameters"]
        fq["fields=first_name,email"]
        flq["filter=age >= 18 AND status IN ('active')"]
        sq["sort=created_at DESC"]
    end

    fq --> FieldsParser
    flq --> FilterParser
    sq --> SortParser

    FieldsParser --> FN["FieldsNode<br/>validated []string"]
    FilterParser --> AST["AST<br/>walkable Node tree"]
    SortParser --> SN["SortNode<br/>[]SortFieldNode"]

    allow(["Shared allow-list<br/>(supports dotted paths)"])
    allow -. gates .-> FieldsParser
    allow -. gates .-> FilterParser
    allow -. gates .-> SortParser
Loading
Parser Input example Output Complexity
FieldsParser first_name, email FieldsNode comma-split validation
SortParser first_name ASC, created_at DESC SortNode comma-split + direction check
FilterParser age >= 18 AND status IN ('active') AST (Node) full recursive-descent grammar

Guides

Guide What it covers
Getting Started Install, update, and a complete runnable example of the three parsers
Filtering The full filter grammar — every operator/predicate, dotted fields, and worked examples
Configuration Restricting which operators and sort directions are allowed
Error Handling Error shapes and how to inspect validation failures
Migration Guide Breaking changes and how to upgrade between versions

The full API reference is on pkg.go.dev, including runnable examples.