aws-cloudformation / aws-cloudformation/cloudformation-resource-schema

Add code examples property to schema

Open
#90 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
96
Forks
38
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

Research direction

No source files, tests, or entry points are named in the issue. Start by locating the schema definition and its validation or serialization tests, then confirm how an optional templateExamples array should be represented and how documentation generation consumes it.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.