forked from radiantearth/community-sprints
-
Notifications
You must be signed in to change notification settings - Fork 0
/
core-api-schema.yaml
313 lines (313 loc) · 7.07 KB
/
core-api-schema.yaml
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
swagger: '2.0'
basePath: /
info:
version: 0.0.1
title: Core catalog api schema
description: description
consumes:
- application/json
produces:
- application/json
paths:
/schemas:
get:
summary: Get list of schemas
operationId: getSchemas
responses:
'200':
description: Successful schema
schema:
type: object
additionalProperties:
$ref: '#/definitions/Schema'
'/schemas/{schemaId}':
get:
summary: Get schemas
operationId: getSchemaById
parameters:
- name: schemaId
in: path
required: true
type: string
responses:
'200':
description: Successful resposne
schema:
$ref: '#/definitions/Schema'
definitions:
Schema:
additionalProperties:
$ref: '#/definitions/SchemaItem'
SchemaItem:
required:
- type
properties:
description:
$ref: '#/definitions/SchemaDescription'
constraint:
$ref: '#/definitions/SchemaPropertyConstraints'
type:
$ref: '#/definitions/SchemaPropertyType'
SchemaDescription:
required:
- title
properties:
title:
type: string
description: 'Title of this dimension, normally used for display to a human'
uom:
type: string
description: Units of Measure
unitsSymbol:
type: string
description: Symbol of the units
keywords:
type: array
description: >-
Unordered list of one or more commonly used or formalised word(s) or
phrase(s) used to describe this type
items:
type: string
SchemaPropertyConstraints:
type: object
externalDocs:
url: >-
https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5
description: Derived from Json/Swagger schema
properties:
maximum:
type: number
exclusiveMaximum:
type: boolean
minimum:
type: number
exclusiveMinimum:
type: boolean
maxLength:
type: integer
minLength:
type: integer
pattern:
type: string
maxItems:
type: integer
minItems:
type: integer
uniqueItems:
type: boolean
multipleOf:
type: number
SchemaPropertyType:
type: string
enum:
- String
- Text
- Int32
- Int64
- Double
- Time
- StringSet
- Int64Set
- TimeRange
- Int64Range
- DoubleRange
- Doc
- Geo
description: |
* `String` - A text string
* `Text` - A text string with text-search index
* `Int32` - 32-bit integer
* `Int64` - 64-bit integer
* `Double` - IEEE double-precision floating-point Number
* `Time` - A timestamp with millisecond precision
* `StringSet` - A set made of text entities
* `Int64Set` - A set made of 64-bit integer
* `TimeRange` - A time range with begin and end
* `Int64Range` - A integer range with begin and end
* `DoubleRange` - A floating-point range with begin and end
* `Doc` - Arbitrary Document
* `Geo` - Geojson geometry
Time:
type: integer
format: int64
description: UTC Timestamp with millisecond precision
minimum: 0
StringSet:
type: array
items:
type: string
Int64Set:
type: array
items:
type: integer
format: int64
TimeRange:
description: begin and end UTC timestamps with millisecond precision
properties:
begin:
type: integer
format: int64
minimum: 0
end:
type: integer
format: int64
minimum: 0
Int64Range:
description: An integer range with begin and end
properties:
begin:
type: integer
format: int64
end:
type: integer
format: int64
DoubleRange:
description: A double range with begin and end
properties:
begin:
type: number
format: double
end:
type: number
format: double
Doc:
description: Arbitrary json document
additionalProperties:
type: object
GeoJson:
description: root geojson object
properties:
type:
$ref: '#/definitions/FeatureType'
required:
- type
discriminator: type
FeatureType:
type: string
enum:
- Point
- MultiPoint
- LineString
- MultiLineString
- Polygon
- MultiPolygon
- GeometryCollection
- Feature
- FeatureCollection
GeometryCollection:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
geometries:
$ref: '#/definitions/GeometryCollection2D'
required:
- geometries
MultiPolygon:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
coordinates:
$ref: '#/definitions/MultiPolygon2D'
required:
- coordinates
MultiLineString:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
coordinates:
$ref: '#/definitions/MultiLineString2D'
required:
- coordinates
MultiPoint:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
coordinates:
$ref: '#/definitions/MultiPoint2D'
required:
- coordinates
Polygon:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
coordinates:
$ref: '#/definitions/Polygon2D'
required:
- coordinates
LineString:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
coordinates:
$ref: '#/definitions/LineString2D'
required:
- coordinates
Point:
allOf:
- $ref: '#/definitions/GeoJson'
- type: object
properties:
coordinates:
$ref: '#/definitions/Point2D'
required:
- coordinates
GeoPolygon2D:
description: A geojson 2d polygon
type: object
properties:
type:
description: Type of geometry
type: string
enum:
- Polygon
coordinates:
$ref: '#/definitions/Polygon2D'
required:
- type
- coordinates
GeometryCollection2D:
type: array
items:
$ref: '#/definitions/GeoJson'
MultiPolygon2D:
type: array
items:
$ref: '#/definitions/Polygon2D'
Polygon2D:
type: array
minItems: 1
items:
$ref: '#/definitions/LinearRing2D'
MultiLineString2D:
type: array
items:
$ref: '#/definitions/LineString2D'
LinearRing2D:
type: array
minItems: 4
items:
$ref: '#/definitions/Point2D'
LineString2D:
type: array
minItems: 2
items:
$ref: '#/definitions/Point2D'
MultiPoint2D:
type: array
minItems: 2
items:
$ref: '#/definitions/Point2D'
Point2D:
description: A 2d geojson point
type: array
minimum: 2
maximum: 2
items:
type: number
format: double