summaryrefslogtreecommitdiff
path: root/api_query_result-1.schema.json
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2022-02-08 16:07:10 +0100
committerWojtek Kosior <koszko@koszko.org>2022-02-09 13:34:46 +0100
commitc72c8438875d20b156d22d975523a19bbb407d95 (patch)
tree5645719cd926b80a4c736e65587818249cde4fed /api_query_result-1.schema.json
parentca1de2ed4a69a71f2f75552ade693d04ea1baa85 (diff)
downloadhydrilla-json-schemas-c72c8438875d20b156d22d975523a19bbb407d95.tar.gz
hydrilla-json-schemas-c72c8438875d20b156d22d975523a19bbb407d95.zip
refactor some definitions into a separate file and add schemas for API endpoints
Diffstat (limited to 'api_query_result-1.schema.json')
-rw-r--r--api_query_result-1.schema.json23
1 files changed, 23 insertions, 0 deletions
diff --git a/api_query_result-1.schema.json b/api_query_result-1.schema.json
new file mode 100644
index 0000000..a8dd30a
--- /dev/null
+++ b/api_query_result-1.schema.json
@@ -0,0 +1,23 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://hydrilla.koszko.org/api_query_result-1.schema.json",
+ "title": "Query result",
+ "description": "Object with a list of references to mappings that contain payloads for requested URL",
+ "type": "object",
+ "required": [
+ "api_schema_version",
+ "mappings"
+ ],
+ "properties": {
+ "api_schema_version": {
+ "$ref": "./common_definitions-1.schema.json#/definitions/schema_version"
+ },
+ "mappings": {
+ "description": "References to mappings using at least one pattern that matches the requested URL",
+ "type": "array",
+ "items": {
+ "$ref": "./common_definitions-1.schema.json#/definitions/item_ref"
+ }
+ }
+ }
+}