noccylabs/schemas
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated flavorstash readme

Browse Source
This commit is contained in:
Chris 2020-08-13 23:58:33 +00:00
parent 42e082fdd1
commit 9240f1c609
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
json/vape/flavorstash/README.md
View File

@ -5,4 +5,37 @@ 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 |