query.schema.json

{"meta:license":["Copyright 2019 Adobe. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the \"License\");","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0","","Unless required by applicable law or agreed to in writing, software distributed under","the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS","OF ANY KIND, either express or implied. See the License for the specific language","governing permissions and limitations under the License."],"$id":"https://ns.adobe.com/helix/shared/query","$schema":"http://json-schema.org/draft-07/schema#","title":"Query","description":"A named query that can be run against an index","type":"object","properties":{"query":{"type":["string","object","array"],"description":"The base query to run. If the value is an object or array, use [QBL JSON or YAML notation](https://github.com/adobe/helix-querybuilder#as-json-or-yaml)","default":"*"},"hitsPerPage":{"type":"integer","minimum":1,"default":25,"description":"How many hits each page of search results should contain"},"cache":{"type":"integer","description":"How long (in seconds) search results should be cached on the CDN","default":0},"parameters":{"type":"array","default":[],"items":{"type":"string","minLength":1},"description":"Which URL parameters to accept in the query when served on the web"},"filters":{"type":"string","description":"An ES6 template expression that determines which filters to apply"}}}