forked from folio-org/mod-reporting
-
Notifications
You must be signed in to change notification settings - Fork 0
/
query-schema.json
96 lines (96 loc) · 2.99 KB
/
query-schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A query to send to the LDP",
"type": "object",
"properties": {
"tables": {
"type": "array",
"description": "A currently redundant wrapper",
"items": {
"type": "object",
"properties": {
"schema": {
"type": "string",
"description": "The LDP schema containing the table to query"
},
"tableName": {
"type": "string",
"description": "The table to query"
},
"columnFilters": {
"type": "array",
"description": "A set of conditions which result rows must satisfy",
"items": {
"type": "object",
"description": "A single condition which result rows must satisfy",
"properties": {
"key": {
"type": "string",
"description": "The name of a column within the specified table"
},
"value": {
"type": "string",
"description": "The value that the specified column must match"
}
},
"additionalProperties": false,
"required": [
"key",
"value"
]
}
},
"showColumns": {
"type": "array",
"description": "An ordered list of column to include in the results",
"items": {
"type": "string",
"description": "The name of a column within the specified table"
}
},
"orderBy": {
"type": "array",
"description": "An ordered list of criteria to sort be",
"items": {
"type": "object",
"description": "A single sorting criterion",
"properties": {
"key": {
"type": "string",
"description": "The name of a column within the specified table"
},
"direction": {
"type": "string",
"enum": ["asc", "desc"],
"description": "Indication of which direction to sort this column [default: 'asc']"
},
"nulls": {
"type": "string",
"enum": ["start", "end"],
"description": "Indication of where null values should sort [default: 'end']"
}
},
"additionalProperties": false,
"required": [
"key"
]
}
},
"limit": {
"type": ["integer", "string"],
"description": "The maximum number of rows to return"
}
},
"additionalProperties": false,
"required": [
"schema",
"tableName"
]
}
}
},
"additionalProperties": false,
"required": [
"tables"
]
}