oam/knowledge base/yaml.md

YAML

1. TL;DR
2. Further readings

TL;DR

There is no key naming convention.
Best practice is to use the one used by the users or tools using that file (e.g.: Kubernetes --> camelCase, CircleCI --> snake_case, Jenkins --> kebab-case).

---
# This is a comment
string: this is a string
number: 0
truthy: true
list:
  - element
  - element
object:
  key: value
  nested:
    can: do
    lists:
      - too
"key:with:chars": requiring quotation

Further readings

• yaml-multiline.info
• yamllint
• What is the canonical YAML naming style