Auto-Generated Documentation
This set of documentation is automatically generated from source, and will help ensure any change to functionality will always be documented and available on release.
Log¶
Log definition.
Field | Type | Description | Required | Default |
---|---|---|---|---|
timestamp | Date | Timestamp at which the Log event took place. | Yes | None |
key | Keyword | The key whose value changed. | Optional | None |
explanation | Text | A manual description of the changes made. | Optional | None |
previous_version | Keyword | The version this action was applied to. | Optional | None |
new_value | Keyword | The value the key is changing to. | Optional | None |
type | Enum | The operation performed on the value. Values: "appended", "removed", "set" |
Optional | None |
previous_value | Keyword | The value the key is changing from. | Optional | None |
user | Keyword | User ID who created the log event. | Yes | None |