History

Noccy 9240f1c609 Updated flavorstash readme		2020-08-13 23:58:33 +00:00
..
README.md	Updated flavorstash readme	2020-08-13 23:58:33 +00:00
v1-example.json	Initial commit, flavorstash schema	2020-08-13 19:04:28 +02:00
v1-invalid.json	Initial commit, flavorstash schema	2020-08-13 19:04:28 +02:00
v1.schema	Fixed id in flavorstash schema	2020-08-13 19:14:55 +02:00

README.md

FlavorStash Json Schema

This schema was created to make it easy to share or transfer your flavor stash between different websites or applications. This could be used on a website by presenting the json data and allowing the user to copy it and paste it on another site.

Use cases

Any application or site where a list of flavorings is maintained.

Implementation Suggestions

For websites, make the json available to copy (to export) or paste and submit (to import).
For applications, allowing both to save/load from file and clipboard is suggested.

Implementation Details

The schema is as simplified as possible, meaning only the vendor and flavor fields are required for each record.

[
  { "vendor":"TFA", "flavor":"Smooth" }
]

Additional application-specific data can be included:

[
  { "vendor":"TFA", "flavor":"Smooth", "extra":{ "is_additive":true }}
]

Standard Extra keys

The following keys are standardized and should not be used for any other purpose than specified.

Application-specific data can (and should) be namespaced using dots, eg. my_mixer_app.favorite.

Key	Type	Description
`g_ml`	decimal	The specific gravity in grams per 1ml
`is_additive`	bool	If `true` the flavor is an additive