search

aws-cloudformation / cloudformation-resource-schema

The CloudFormation Resource Schema defines the shape and semantic for resources provisioned by CloudFormation. It is used by provider developers using the CloudFormation RPDK.
Apache License 2.0
90 stars 38 forks source link

Add code examples property to schema #90

Open iann0036 opened 4 years ago

iann0036 commented 4 years ago

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 commented 4 years ago

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