Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions 04-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Recommended config:
spec_version: "0.3.0"

settings:
timezone: Australia/Melbourne
types_folder: _types
contracts_folder: _contracts
record_extensions: [md]
Expand All @@ -37,6 +38,7 @@ Pre-1.0 draft versions MAY be accepted by explicit compatibility setting.

| Key | Type | Default | Meaning |
| --- | --- | --- | --- |
| `settings.timezone` | string | local runtime | durable IANA timezone for authority-owned calendar semantics |
| `settings.types_folder` | string | `_types` | folder containing type files |
| `settings.contracts_folder` | string | `_contracts` | folder containing data contract files |
| `settings.record_extensions` | list of strings | `[md]` | record file extensions without dot |
Expand All @@ -49,6 +51,13 @@ Pre-1.0 draft versions MAY be accepted by explicit compatibility setting.
`settings.explicit_type_keys` replaces the default key list. An empty list makes
all type membership inferred.

`settings.timezone`, when present, MUST be an IANA timezone identifier. `UTC`
is the canonical identifier for Coordinated Universal Time. Numeric offsets and
ambient aliases such as `local` are invalid because they do not name a durable
calendar authority or model daylight-saving transitions. An invalid configured
timezone makes the collection configuration invalid; an implementation MUST
NOT silently substitute its runtime timezone.

The types and contracts folders MUST be different normalized paths. Both are
reserved control-file folders and are excluded from ordinary record discovery.

Expand Down
5 changes: 5 additions & 0 deletions schemas/v0.3/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@
"settings": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"minLength": 1,
"description": "Durable IANA timezone for collection-authority calendar semantics"
},
"types_folder": {
"type": "string",
"minLength": 1
Expand Down