fix: more detailed readme

This commit is contained in:
Britton Hayes 2021-10-01 00:42:24 -07:00
parent 6fc4d63bf2
commit 1bd11c863b
No known key found for this signature in database
GPG key ID: 922B4F3652980643

View file

@ -37,3 +37,34 @@ test:
myValue: '1'
myValue2: '2'
```
### More Complex Schema
- Use `?` to indicate an optional field
- Specify the preferred type with values like "string" or "number"
- Replicate deeply nested structures in JSON to represent expected YAML
```json
{
"structure": {
"school": {
"description?": "string",
"code": "number",
"principal": {
"name": "string"
},
"classRooms": [
{
"name": "string",
"id": "number",
"location?": {
"floor": "string",
"building": "string"
}
}
],
"teachers": ["string"]
}
}
}
```