Skip to content
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.

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

feat: add optional lastModified timestamp to Annotated #140

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
24 changes: 24 additions & 0 deletions schema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
"maximum": 1,
"minimum": 0,
"type": "number"
},
"timestamp": {
"description": "The timestamp indicating when this annotation was created or last updated.\n\nShould be an ISO 8601 formatted string (e.g., \"2025-01-12T15:00:58Z\").",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -455,6 +459,10 @@
"maximum": 1,
"minimum": 0,
"type": "number"
},
"timestamp": {
"description": "The timestamp indicating when this annotation was created or last updated.\n\nShould be an ISO 8601 formatted string (e.g., \"2025-01-12T15:00:58Z\").",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -557,6 +565,10 @@
"maximum": 1,
"minimum": 0,
"type": "number"
},
"timestamp": {
"description": "The timestamp indicating when this annotation was created or last updated.\n\nShould be an ISO 8601 formatted string (e.g., \"2025-01-12T15:00:58Z\").",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -1489,6 +1501,10 @@
"maximum": 1,
"minimum": 0,
"type": "number"
},
"timestamp": {
"description": "The timestamp indicating when this annotation was created or last updated.\n\nShould be an ISO 8601 formatted string (e.g., \"2025-01-12T15:00:58Z\").",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -1595,6 +1611,10 @@
"maximum": 1,
"minimum": 0,
"type": "number"
},
"timestamp": {
"description": "The timestamp indicating when this annotation was created or last updated.\n\nShould be an ISO 8601 formatted string (e.g., \"2025-01-12T15:00:58Z\").",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -1931,6 +1951,10 @@
"maximum": 1,
"minimum": 0,
"type": "number"
},
"timestamp": {
"description": "The timestamp indicating when this annotation was created or last updated.\n\nShould be an ISO 8601 formatted string (e.g., \"2025-01-12T15:00:58Z\").",
"type": "string"
}
},
"type": "object"
Expand Down
7 changes: 7 additions & 0 deletions schema/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -832,6 +832,13 @@ export interface Annotated {
* @maximum 1
*/
priority?: number;

/**
* The timestamp indicating when this annotation was created or last updated.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be about the annotation (only) or about the thing that the annotation is attached to? I lean toward the latter—maybe we could update the phrasing to reflect this?

*
* Should be an ISO 8601 formatted string (e.g., "2025-01-12T15:00:58Z").
*/
timestamp?: string;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to have other timestamps in future, so perhaps a more specific name like:

Suggested change
timestamp?: string;
lastModified?: string;

}
}

Expand Down