Naming Conventions¶
Standard naming conventions across all formats and representations.
naming_conventions:
entities:
case: PascalCase
examples: ["Concept", "ConceptualVariable", "Dataset"]
properties:
case: camelCase
examples: ["name", "description", "unitType"]
json_fields:
case: camelCase
examples: ["name", "description", "unitType"]
note: "Same as property names"
xml_elements:
case: PascalCase
examples: ["<Concept>", "<UnitType>"]
conversion_rule: "camelCase → PascalCase"
Compound Words¶
Some terms are treated as single compound words (not hyphenated or split):
| Term | PascalCase | camelCase | kebab-case | INCORRECT |
|---|---|---|---|---|
| Dataset | Dataset |
dataset |
dataset |
~~DataSet~~, ~~data-set~~ |
| Codelist | CodeList |
codeList |
code-list |
(standard rules apply) |
Important: "Dataset" is always one word in this project. Use Dataset, DatasetCollection, DatasetCycle — never DataSet, DataSetCollection, etc.
Conversion Examples¶
| Specification | JSON | XML Element | Database | API Endpoint |
|---|---|---|---|---|
| conceptSystem | conceptSystem | ConceptSystem | concept_system | /concept-systems |
| unitType | unitType | UnitType | unit_type | /unit-types |
| dataset | dataset | Dataset | dataset | /datasets |