summaryrefslogtreecommitdiff
path: root/api_query_result-2.schema.json
diff options
context:
space:
mode:
Diffstat (limited to 'api_query_result-2.schema.json')
-rw-r--r--api_query_result-2.schema.json25
1 files changed, 25 insertions, 0 deletions
diff --git a/api_query_result-2.schema.json b/api_query_result-2.schema.json
new file mode 100644
index 0000000..727531c
--- /dev/null
+++ b/api_query_result-2.schema.json
@@ -0,0 +1,25 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://hydrilla.koszko.org/schemas/api_query_result-2.schema.json",
+ "title": "Query result",
+ "description": "Object with a list of references to mappings that contain payloads for requested URL",
+ "type": "object",
+ "required": ["$schema", "mappings"],
+ "properties": {
+ "$schema": {
+ "description": "Mark this instance as conforming to query result schema 2.x",
+ "type": "string",
+ "pattern": "^https://hydrilla\\.koszko\\.org/schemas/api_query_result-2\\.(([1-9][0-9]*|0)\\.)*schema\\.json$"
+ },
+ "mappings": {
+ "description": "References to mappings using at least one pattern that matches the requested URL",
+ "type": "array",
+ "items": {
+ "$ref": "./common_definitions-2.schema.json#/definitions/item_ref"
+ }
+ },
+ "generated_by": {
+ "$ref": "./common_definitions-2.schema.json#/definitions/generated_by"
+ }
+ }
+}