json-api-query

Validates the parsed query accumulator against a JSON:API query schema, covering filter, sort, fields, include, and page parameters. Uses AJV 8 with JSON Schema 2020-12. Must run after url().

Pipeline stage: Validation (after url())

Import

import { jsonApiQuery } from "@centralping/ergo";

Options

Option	Type	Default	Description
...options	*	—	Forwarded to the JSON:API validator

Return Value

Returns undefined on success — validation is a gate, not a data producer.

Error Responses

Status	Condition
400 Bad Request	Query parameters fail JSON:API schema validation

Usage

Standalone

import { compose, url, jsonApiQuery } from "@centralping/ergo";

const pipeline = compose(
  {fn: url(), setPath: "url"},
  jsonApiQuery(),
  // acc.url.query is validated against JSON:API conventions
);

ergo-router

router.get("/articles", {
  jsonApiQuery: {},
  execute: (req, res, acc) => ({
    response: {
      body: queryArticles(acc.url.query),
    },
  }),
});

RFC References

• JSON:API Specification

API Reference

See the auto-generated jsonApiQuery API docs.