# Query endpoint

This leaf as JSON: https://banes-lab.com/json/api/query
endpoint: https://banes-lab.com/q
index: https://banes-lab.com/json/api/query
site: https://banes-lab.com

## fuzzy

- `stemMinimum`: 5
- `suffixes`: ation, ency, ence, ment, ness, ity, ent, ing, ion, ive, al
- `suggestions`: 5

## limits

- `defaultLimit`: 50
- `depth`: 3
- `limit`: 200

## messages

- `badDepth`: The parameter depth takes a whole number from 1 to {max}.
- `badNumber`: The parameter {name} takes a whole number, and limit is at most {max}.
- `emptyValue`: The parameter {name} is empty. Give it the value to look up.
- `gone`: Nothing is served at this address any longer, because the entry it held was removed.
- `manyOperations`: One request runs one operation. Name only one of ref, name, q, collection, id and walk.
- `missing`: Nothing is served at this address.
- `noOperation`: Name one operation with ref, name, q, collection, id or walk. The parameters are listed at {index}.
- `notFound`: Nothing in the catalog matches this request.
- `staticQuery`: A catalog address is a static file and reads no parameters. Ask the query endpoint named in query instead.
- `unknownKind`: The catalog holds no entries of the kind {name}. The kinds are listed under kinds at {ids}.
- `unknownParameter`: This endpoint does not read the parameter {name}. The parameters are listed at {index}.
- `unknownRelation`: Walk does not follow a relation named {name}. The relations are listed under relations at {index}.

## parameters

- `collection`: An ontology collection to filter, with each further parameter naming a field and the value it must take
- `depth`: With walk, how many steps to follow, from 1 to 3
- `id`: A ref pattern ending in an asterisk, matching every ref that starts with the text before it
- `kind`: With name, q or id, the one kind of entry to keep, named as in kinds
- `limit`: How many results to return, at most 200, and 50 when the request names none
- `name`: A name, acronym or alias, keyed the way the name lookup keys it
- `offset`: How many results to skip
- `q`: Words to search for, each of which has to appear in an entry, as a whole word, a prefix or one edit away
- `ref`: The ref of one catalog entry
- `relation`: With walk, the one relation to follow, named as in relations
- `walk`: A ref to start from, following its relation links

## relations

- allowed-by
- axes
- axis
- axis-of
- builds-on
- called-by
- calls
- category
- composed-by
- composes
- concept
- concept-of
- concern
- concern-layer
- concern-layer-of
- concern-of
- conflicts-with
- contained-in
- contains
- contract
- contract-of
- contracts
- derivation
- derived-by
- detected-by
- detects
- dimension
- dimension-of
- domain
- domain-of
- edge-kind
- edge-kind-of
- edges
- enabled-by
- enables
- enforced-by
- enforces
- evidence
- evidence-for
- evidence-grounds
- evidence-source
- evidence-source-of
- example-shape
- example-shape-of
- expressed-by
- expresses
- force
- force-of
- governed-by
- governs
- grounded-by
- grounds
- invariant
- invariant-of
- kinds
- layer
- layer-of
- lens
- lens-of
- lenses
- linked-from
- links-to
- math-domains
- math-domains-of
- math-type
- math-type-of
- mechanism
- mechanism-of
- members
- mode
- negated-by
- nodes
- predicate-grounds
- predicate-type
- predicate-type-of
- prerequisite-of
- primary-math-type
- primary-math-type-of
- principle
- principle-ref
- principles
- refactored-by
- refactors
- referenced-from
- references
- reinforced-by
- reinforces
- required-by
- requires
- sequence
- sequence-of
- severity
- severity-of
- stage
- stage-of
- stages
- subsumed-by
- subsumes
- surfaces
- techniques
- techniques-of
- tensions
- tensions-of
- tensions-with
- term
- term-of
- terms
- test-surfaces
- tier
- tier-of
- transitions-from
- transitions-to
- universal-axis
- universal-axis-of
- used-by
- uses
- verdict-domain
- verdict-domain-of
- violated-by
- violates
