Schema example improvements

[Fishbowler]

Examples currently take two forms:

JSON type:

"examples": [
    {
        "times": 3,
        "commands": [
            {
                "inputText": "Retry"
            },
            {
                "pressKey": "enter"
            }
        ]
    } //snip
]

Plain text type:

"examples": [
    {
        "description": "Detailed assertion with condition and label",
        "example": "- assertTrue:\n    condition: \"document.querySelector('#button').disabled === false\"\n    label: \"Verify button is enabled\""
    }
]

Problem:

We should standardise.

The former is easier to write. The latter feels more user friendly.

Is there a third option?

[Mastersam07]

There is no third option. I am thinking we standardise the second option.

We have commands in the below formats:

• constant strings
• commands that take a string
• commands that takes an object

eg: LaunchApp works as shown:

- launchApp
- launchApp: com.example.wallet
- launchApp: 
    appId: com.example.wallet
    label: Some label

Trying to represent these 3 different patterns using the first example approach isn't clear.

The second approach however allows to display the example and format it the way we want. Plus its feels more user friendly.

[Fishbowler]

Agree.
I can't find any good knowledge on the internet for approaches to this problem. Let's pick our standard and keep to it.
I wonder if it's something we can lint for?