schema
constschema:object
Defined in: lib/json-api-query/index.js:24
A deep copy of the default JSON API query schema, computed once at module load. Callers should clone again if mutation is needed.
Type Declaration
Section titled “Type Declaration”$id:
string="jsonapi.json"
$schema
Section titled “$schema”$schema:
string="https://json-schema.org/draft/2020-12/schema"
additionalProperties
Section titled “additionalProperties”additionalProperties:
boolean=false
description
Section titled “description”description:
string="Validation schema for validating JSON API querystrings"
if:
object
if.properties
Section titled “if.properties”properties:
object
if.properties.page
Section titled “if.properties.page”page:
object
if.properties.page.required
Section titled “if.properties.page.required”required:
string[]
if.required
Section titled “if.required”required:
string[]
patternProperties
Section titled “patternProperties”patternProperties:
object
patternProperties.[^a-z]
Section titled “patternProperties.[^a-z]”[^a-z]:
object
patternProperties.[^a-z].description
Section titled “patternProperties.[^a-z].description”description:
string="https://jsonapi.org/format/#query-parameters"
patternProperties.[^a-z].type
Section titled “patternProperties.[^a-z].type”type:
string[]
properties
Section titled “properties”properties:
object
properties.fields
Section titled “properties.fields”fields:
object
properties.fields.additionalProperties
Section titled “properties.fields.additionalProperties”additionalProperties:
object
properties.fields.additionalProperties.items
Section titled “properties.fields.additionalProperties.items”items:
object
properties.fields.additionalProperties.items.type
Section titled “properties.fields.additionalProperties.items.type”type:
string="string"
properties.fields.additionalProperties.minItems
Section titled “properties.fields.additionalProperties.minItems”minItems:
number=1
properties.fields.additionalProperties.type
Section titled “properties.fields.additionalProperties.type”type:
string="array"
properties.fields.additionalProperties.uniqueItems
Section titled “properties.fields.additionalProperties.uniqueItems”uniqueItems:
boolean=true
properties.fields.description
Section titled “properties.fields.description”description:
string="https://jsonapi.org/format/#fetching-sparse-fieldsets"
properties.fields.minProperties
Section titled “properties.fields.minProperties”minProperties:
number=1
properties.fields.type
Section titled “properties.fields.type”type:
string="object"
properties.filter
Section titled “properties.filter”filter:
object
properties.filter.description
Section titled “properties.filter.description”description:
string="https://jsonapi.org/format/#fetching-filtering"
properties.filter.minProperties
Section titled “properties.filter.minProperties”minProperties:
number=1
properties.filter.type
Section titled “properties.filter.type”type:
string="object"
properties.include
Section titled “properties.include”include:
object
properties.include.description
Section titled “properties.include.description”description:
string="https://jsonapi.org/format/#fetching-includes"
properties.include.items
Section titled “properties.include.items”items:
object
properties.include.items.type
Section titled “properties.include.items.type”type:
string="string"
properties.include.minItems
Section titled “properties.include.minItems”minItems:
number=1
properties.include.type
Section titled “properties.include.type”type:
string="array"
properties.include.uniqueItems
Section titled “properties.include.uniqueItems”uniqueItems:
boolean=true
properties.page
Section titled “properties.page”page:
object
properties.page.additionalProperties
Section titled “properties.page.additionalProperties”additionalProperties:
boolean=false
properties.page.dependentRequired
Section titled “properties.page.dependentRequired”dependentRequired:
object
properties.page.dependentRequired.number
Section titled “properties.page.dependentRequired.number”number:
string[]
properties.page.dependentRequired.offset
Section titled “properties.page.dependentRequired.offset”offset:
string[]
properties.page.description
Section titled “properties.page.description”description:
string="https://jsonapi.org/format/#fetching-pagination"
properties.page.else
Section titled “properties.page.else”else:
object
properties.page.else.if
Section titled “properties.page.else.if”if:
object
properties.page.else.if.required
Section titled “properties.page.else.if.required”required:
string[]
properties.page.else.maxProperties
Section titled “properties.page.else.maxProperties”maxProperties:
number=2
properties.page.else.then
Section titled “properties.page.else.then”then:
object
properties.page.else.then.not
Section titled “properties.page.else.then.not”not:
object
properties.page.else.then.not.required
Section titled “properties.page.else.then.not.required”required:
string[]
properties.page.if
Section titled “properties.page.if”if:
object
properties.page.if.required
Section titled “properties.page.if.required”required:
string[]
properties.page.minProperties
Section titled “properties.page.minProperties”minProperties:
number=1
properties.page.properties
Section titled “properties.page.properties”properties:
object
properties.page.properties.cursor
Section titled “properties.page.properties.cursor”cursor:
object
properties.page.properties.cursor.minLength
Section titled “properties.page.properties.cursor.minLength”minLength:
number=1
properties.page.properties.cursor.type
Section titled “properties.page.properties.cursor.type”type:
string="string"
properties.page.properties.limit
Section titled “properties.page.properties.limit”limit:
object
properties.page.properties.limit.minimum
Section titled “properties.page.properties.limit.minimum”minimum:
number=1
properties.page.properties.limit.type
Section titled “properties.page.properties.limit.type”type:
string="integer"
properties.page.properties.number
Section titled “properties.page.properties.number”number:
object
properties.page.properties.number.minimum
Section titled “properties.page.properties.number.minimum”minimum:
number=1
properties.page.properties.number.type
Section titled “properties.page.properties.number.type”type:
string="integer"
properties.page.properties.offset
Section titled “properties.page.properties.offset”offset:
object
properties.page.properties.offset.minimum
Section titled “properties.page.properties.offset.minimum”minimum:
number=0
properties.page.properties.offset.type
Section titled “properties.page.properties.offset.type”type:
string="integer"
properties.page.properties.size
Section titled “properties.page.properties.size”size:
object
properties.page.properties.size.minimum
Section titled “properties.page.properties.size.minimum”minimum:
number=1
properties.page.properties.size.type
Section titled “properties.page.properties.size.type”type:
string="integer"
properties.page.then
Section titled “properties.page.then”then:
object
properties.page.then.maxProperties
Section titled “properties.page.then.maxProperties”maxProperties:
number=1
properties.page.type
Section titled “properties.page.type”type:
string="object"
properties.sort
Section titled “properties.sort”sort:
object
properties.sort.description
Section titled “properties.sort.description”description:
string="https://jsonapi.org/format/#fetching-sorting"
properties.sort.items
Section titled “properties.sort.items”items:
object
properties.sort.items.type
Section titled “properties.sort.items.type”type:
string="string"
properties.sort.minItems
Section titled “properties.sort.minItems”minItems:
number=1
properties.sort.type
Section titled “properties.sort.type”type:
string="array"
properties.sort.uniqueItems
Section titled “properties.sort.uniqueItems”uniqueItems:
boolean=true
then:
object
then.not
Section titled “then.not”not:
object
then.not.anyOf
Section titled “then.not.anyOf”anyOf:
object[]
title:
string="JSON API Request Validation"
type:
string="object"
Member
Section titled “Member”schema JSON Schema 2020-12