Skip to content

okf: align timestamp as recommended and note staleness use (SPEC 4.1) #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manumishra12 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

okf: align timestamp as recommended and note staleness use (SPEC 4.1) #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions okf/SPEC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ title: <Optional display name>
description: <Optional one-line summary>
resource: <Optional canonical URI for the underlying asset>
tags: [<tag>, <tag>, …] # Optional
timestamp: <ISO 8601 datetime> # Optional last-modified time
timestamp: <ISO 8601 datetime> # Recommended last-modified time
# … other producer-defined key/value pairs
---
```
Expand All @@ -155,7 +155,9 @@ timestamp: <ISO 8601 datetime> # Optional last-modified time
concept describes. Absent for concepts that describe abstract ideas
rather than physical resources.
- `tags` — A YAML list of short strings for cross-cutting categorization.
- `timestamp` — ISO 8601 datetime of last meaningful change.
- `timestamp` — ISO 8601 datetime of last meaningful change. Because
consumers rely on it to detect stale knowledge, producers SHOULD set it
whenever a concept is created or updated.

**Extensions:** Producers MAY include any additional keys. Consumers
SHOULD preserve unknown keys when round-tripping and SHOULD NOT reject
Expand Down