Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add code examples property to schema #90

Open
iann0036 opened this issue Mar 28, 2020 · 1 comment
Open

Add code examples property to schema #90

iann0036 opened this issue Mar 28, 2020 · 1 comment

Comments

@iann0036
Copy link

It would be great (mostly for documentation generation) if the schema top-level could have an optional array of example model values. Something like:

{
    "typeName": "Foo::Bar::Baz",
    "properties": {
        "someprop": {
            "type": "string"
        }
    },
    ...
    "templateExamples": [
        {
            "description": "A basic example",
            "model": {
                "someprop": "An example value"
            }
        }
    ]
}

Labels: enhancement

@PatMyron
Copy link
Contributor

PatMyron commented May 7, 2020

would be nice, been maintaining minimal examples here in the meantime

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants