-
-
Notifications
You must be signed in to change notification settings - Fork 113
Metadata
Metadata may be stored with items, entities, and relationships between items/entities. It takes the form of a simple key-value store and is encoded as a JSON object in the database. This unstructured format is simple and highly flexible.
Metadata keys+values should be represented consistently across data sources for those which provide equivalent metadata. This forms metadata conventions that the frontend UI can more or less depend on. These conventions are documented on this page. For example, any data source providing velocity information for an item should use the key "Velocity" with an integer value in meters per second.
The frontend can be programmed to use these metadata conventions in various contexts to provide a richer experience. For example, metadata is used to show where entities are in photos. Being documented on this page does not mean that the UI necessarily uses the convention, but it may do so in the future without difficulty/ambiguity.
Keys take a human-natural form with spaces and the first word, proper names, and initialisms are capitalized.
These metadata conventions are not an external API contract, so they are subject to change. (But we still prefer not to change them.)
| Key | Type | Description | Example |
|---|---|---|---|
| Velocity | int |
Meters per second | |
| Pin * | Relating to a location 'pin' referenced in the item | ||
| Pin latitude | float64 |
The pin's latitude | 30.536731 |
| Pin longitude | float64 |
The pin's longitude | -98.361905 |
| Pin foursquare id | string |
The Foursquare Venue ID of the pin | 4ba6419bf964a520b23f39e3 |
| Poll * | Relating to a Multiple choice/Poll in the item | ||
| Poll question | string |
The question asked in the poll | What's your favourite cheese? |
| Poll option N | string |
The Nth option of the poll (starting at 1) | Gouda |
| Poll votes N | int |
The number of votes for the Nth option of the poll | 3 |
| Modified |
bool (only true) |
Indicates that this item has been modified, potentially since it was replied to | true |
| Key | Type | Description | Example |
|---|
| Key | Type | Description | Example |
|---|---|---|---|
| Center X | float64 |
Center of face across the X dimension (from left) (0 <= x <= 1) | 0.0422 |
| Center Y | float64 |
Center of face across the Y dimension (from bottom) (0 <= y <= 1) | 0.7564117 |
| Size | float64 |
Size of face | 0.109343 |