UNPKG

@mapeo/schema

Version:

JSON schema and flow types for Mapeo

github.com/digidem/mapeo-schema

digidem/mapeo-schema

158 lines (84 loc) • 2.36 kB
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
[API](../README.md) / Filter # Interface: Filter A filter is a saved view of data in the Mapeo database, filtered by tag or date. E.g. a filter could define observations between two dates, or only observations with the tag `public=true` ## Indexable ▪ [k: `string`]: `unknown` ## Table of contents ### Properties - [created\_at](Filter.md#created_at) - [deviceId](Filter.md#deviceid) - [filter](Filter.md#filter) - [id](Filter.md#id) - [links](Filter.md#links) - [name](Filter.md#name) - [schemaVersion](Filter.md#schemaversion) - [timestamp](Filter.md#timestamp) - [type](Filter.md#type) - [userId](Filter.md#userid) - [version](Filter.md#version) ## Properties ### created\_at • **created\_at**: `string` RFC3339-formatted datetime of when the first version of the element was created #### Defined in filter/v1.ts:23 ___ ### deviceId • `Optional` **deviceId**: `string` ID of the device that made this edit #### Defined in filter/v1.ts:35 ___ ### filter • **filter**: `unknown`[] A filter expression as defined in https://docs.mapbox.com/mapbox-gl-js/style-spec/#other-filter but where the special fields `$type` refers to the mapeo type (observation, node, way etc) and `$id` is the mapeo id. #### Defined in filter/v1.ts:51 ___ ### id • **id**: `string` Unique value that identifies this element #### Defined in filter/v1.ts:15 ___ ### links • `Optional` **links**: `string`[] Version ids of the previous document versions this one is replacing #### Defined in filter/v1.ts:43 ___ ### name • **name**: `string` A human-readable name for this filter. #### Defined in filter/v1.ts:55 ___ ### schemaVersion • **schemaVersion**: ``1`` Version of this schema. Should increment for breaking changes to the schema #### Defined in filter/v1.ts:47 ___ ### timestamp • `Optional` **timestamp**: `string` RFC3339-formatted datetime of when this version of the element was created #### Defined in filter/v1.ts:27 ___ ### type • **type**: ``"filter"`` Must be `filter` #### Defined in filter/v1.ts:39 ___ ### userId • `Optional` **userId**: `string` ID of the user who edited/created this record #### Defined in filter/v1.ts:31 ___ ### version • **version**: `string` Unique value that identifies this particular version of this element #### Defined in filter/v1.ts:19