-
Notifications
You must be signed in to change notification settings - Fork 173
/
api-schema.json
231 lines (231 loc) · 6.87 KB
/
api-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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://tabris.com/api-schema.json",
"title": "Tabris.js API Definition JSON Schema",
"definitions": {
"api": {
"type": "object",
"properties": {
"title": {
"description": "The title of the document. Will default to object or type name.",
"type": "string"
},
"description": {
"type": "string"
},
"namespace": {
"enum": ["global", "tabris"]
},
"type": {
"description": "Name of the class",
"type": "string"
},
"object": {
"description": "Name of the instance (for singletons)",
"type": "string"
},
"extends": {
"type": "string"
},
"generics": {
"description": "Typescript only",
"type": "string"
},
"constructor": {
"properties": {
"access" : {
"enum": [
"public",
"protected",
"private"
]
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/parameter"
}
}
},
"required": ["access"],
"additionalProperties": false
},
"properties": {
"description": "Change events will be generated automatically if type extends NativeObject",
"type": "object",
"patternProperties": {
"(^_?[a-z]\\w+$)|(^\\[.*\\]$)": {"$ref": "#/definitions/property"}
},
"additionalProperties": false
},
"methods": {
"type": "object",
"patternProperties": {
"(^_?[a-z]\\w+$)|(^\\[.*\\]$)": {
"anyOf": [
{"$ref": "#/definitions/method"},
{"type": "array", "items": {"$ref": "#/definitions/method"}}
]
}
},
"additionalProperties": false
},
"events": {
"type": "object",
"patternProperties": {
"^[a-z]\\w+$": {"$ref": "#/definitions/event"}
},
"additionalProperties": false
},
"links": {
"type": "array",
"items": {
"properties": {
"title": {"type": "string"},
"path": {"type": "string"}
},
"additionalProperties": false
}
}
},
"dependencies": {
"extends": ["type"],
"object": ["type"],
"generics": ["type"],
"constructor": ["type"],
"events": ["type"]
},
"allOf": [
{
"$comment": "Where is the API located?",
"anyOf": [
{"required": ["type"]},
{"required": ["object"]},
{"required": ["namespace"]}
]
},
{
"$comment": "What is the document named?",
"anyOf": [
{"required": ["title"]},
{"required": ["object"]},
{"required": ["type"]}
]
}
],
"additionalProperties": false
},
"property": {
"type": "object",
"properties": {
"description": {"type": "string"},
"changeEventDescription": {"type": "string"},
"type": {"type": "string"},
"ts_type": {
"description": "Overrides \"type\" for TypeScript declarations",
"type": "string"
},
"ts_only": {
"description": "Exclude this property from documentation",
"type": "boolean"
},
"platforms": {"$ref": "#/definitions/platforms"},
"readonly": {
"description": "Indicates that this property can not be set. However, if the property is not \"static\", it may change by itself. Defaults to false",
"type": "boolean"
},
"static": {
"description": "Indicates that this property can not change during the lifetime of this object. However, if there is a public constructor and the property is not \"readonly\", it can be set via constructor. No change events will be generated for this property. Defaults to false",
"type": "boolean"
},
"default": {
"description": "Default value of this property"
},
"values": {
"description": "Limits the possible values of this property",
"type": "array",
"items": {
"oneOf": [
{"type": "string"},
{"type": "number"},
{"type": "boolean"}
]
}
}
},
"required": ["type"],
"additionalProperties": false
},
"event": {
"type": "object",
"properties": {
"description": {"type": "string"},
"eventObject": {
"type": "string",
"description": "The name of the generated event object interface for TypeScript declaration. Defaults to \"{TypeName}{EventName}Event\". Useful for merging multiple identical event interfaces."
},
"platforms": {"$ref": "#/definitions/platforms"},
"parameters": {
"type": "object",
"patternProperties": {
"^_?[a-z]\\w+$": {"$ref": "#/definitions/property"}
}
}
},
"additionalProperties": false
},
"method": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/parameter"
}
},
"returns": {"type": "string"},
"ts_only": {"type": "boolean"},
"ts_returns": {
"description": "Overrides \"returns\" for TypeScript declarations",
"type": "string"
},
"description": {"type": "string"},
"generics": {
"description": "TypeScript only",
"type": "string"
},
"platforms": {"$ref": "#/definitions/platforms"},
"protected": {"type": "boolean"},
"provisional": {"type": "boolean"}
},
"additionalProperties": false
},
"parameter": {
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"type": {"type": "string"},
"ts_type": {
"description": "Overrides \"type\" for TypeScript declarations",
"type": "string"
},
"optional": {
"description": "Defaults to false",
"type": "boolean"
}
},
"required": ["name", "type"],
"additionalProperties": false
},
"platforms": {
"type": "object",
"properties": {
"ios": {"type": "boolean", "description": "Defaults to true"},
"android": {"type": "boolean", "description": "Defaults to true"}
},
"additionalProperties": false
}
},
"oneOf": [{"$ref": "#/definitions/api"}]
}