JSON Schema for app.json?

Tombo · April 2016

Hey guys,

Searched the forums, but haven't really found an answer on this. Is there already a JSON schema (http://json-schema.org/) for the app.json file?

If not I'll whip one together :-)

Cheers
Tom

MarcoF · April 2016

http://developers.athom.com/library/introduction/


{
    "id": "com.athom.hello",
    "version": "1.0.0",
    "compatibility": ">=1.2.3",
    "name": {
        "en": "Hello World!",
        "nl": "Hallo wereld!"
    },
    "description": {
        "en": "This is an example app for Homey",
        "nl": "Dit is een voorbeeld app voor Homey"
    },
    "permissions": [
        "homey:manager:speech-output"
    ],
    "speech": [
        {
            "id": "hello",
            "importance": 0.6,
            "synonyms": {
                "en": [ "hello", "hi", "hey" ]
            }
        }
    ]
}

Tombo · April 2016

Yup, indeed. But that's a basic app.
Do you mean there is none yet?

A JSON schema could ease writing app.json's, as editors (intelli j, webstorm, vs code, vs, ..) provide intellisense for files. :-)

MarcoF · April 2016

As far as i known, this is all there is....

jjtbsomhorst · April 2016

That json is not complete. It misses flows and such. I think it's best to scroll through the api's an whip one yourself. Would be great to have one

Tombo · April 2016

Hey guys,

So I created one myself :-)

Image: https://forum.athom.com/uploads/editor/2u/y4659mumiei7.png

Some remarks on this:

To use it, just add the property "$schema" in the root object and as value: "https://raw.githubusercontent.com/tmsns/homey-json-schema/master/schema.json"
You can also download it locally.
Supported IDE's: (that I know of)
- Visual Studio
- Visual Studio Code
- WebStorm
- IntelliJ IDEA
This is a first version. I'll try to update it as I can.
- the basic structure should be there (based myself on the apps better-logic and kodi)
- a small set of properties have gotten full descriptions
- enums and advanced patterns are not added yet
To Athom, feel free to copy the schema in your own repository. It would be better to have something like:
https://schemas.athom.com/app/v1/schema.json
To other dev's, it's a GitHub repo. https://github.com/tmsns/homey-json-schema So, if you see issues, feel free to submit pull requests.

Cheers
Tom

RobinVanKekem · April 2016

Tombo said:

Hey guys,

So I created one myself :-)

Some remarks on this:
To use it, just add the property "$schema" in the root object and as value: "https://raw.githubusercontent.com/tmsns/homey-json-schema/master/schema.json"
You can also download it locally.
Supported IDE's: (that I know of)
Visual Studio
Visual Studio Code
WebStorm
IntelliJ IDEA
This is a first version. I'll try to update it as I can.
the basic structure should be there (based myself on the apps better-logic and kodi)
a small set of properties have gotten full descriptions
enums and advanced patterns are not added yet
To Athom, feel free to copy the schema in your own repository. It would be better to have something like:
https://schemas.athom.com/app/v1/schema.json
To other dev's, it's a GitHub repo. https://github.com/tmsns/homey-json-schema So, if you see issues, feel free to submit pull requests.
Cheers
Tom

I've tried googling for it but could not find anything.
Where should I create the property?

DaneeDeKruyff · April 2016

It's in the screenshot, the first line. (Actualy line nr 2 to be correct)

RobinVanKekem · April 2016

I'm truly sorry. Didn't see the screenshot before!

RobinVanKekem · April 2016

Found all the permissions which Homey has:

https://github.com/athombv/node-homey-lib/blob/51d2e942ba574aef46e4d560e2df580136d4b88d/lib/permissions/permissions.json

EvertorN · April 2016

Awesome initiative! Definitely going to use this!

Tombo · April 2016

Thx Robin. Let's fire up Code and add it. :-)

edit: done! I'll take a look at this node-homey-lib repo to see if I can find other elements to (better) support a well.

jjtbsomhorst · November 2016

@RobinVanKekem wat is the status of this? Is it compatible with the latest firmwares?

RobinVanKekem · November 2016

Don't know, Tombo made it...

miguel9 · October 2017

That json is not complete yet. Flows and such missed. Wanted to know the status...
Validate and format it here: JSON formatter

JSON Schema for app.json?

Comments