Add PersonalNote ontology schema - #1100
Open
EgorPPS wants to merge 1 commit into
Open
Conversation
A person's own note — the general case that has been missing: the existing Note ontology is platform documentation (no author, no creation time, content is a file URI), and TaskNote is scoped to a task. Modelled on schema.org/NoteDigitalDocument, with identity and time fields following this registry's convention (id / createdAt / authorEName) rather than schema.org's, so it reads like its neighbours here.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded a draft-07 JSON Schema for ChangesPersonalNote schema
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
PersonalNote— a note a person wrote for themselves.Why a new schema rather than reuse
The registry currently has no type for this, and the two nearest candidates are both something else:
Note(18a83870-…) is platform documentation. Every record of it in the wild is an integration note or a marketplace listing ("Ontology: File", "Marketplace Listing"); it has no author and no creation time, itscontentis a URI pointing at a file, and itsaudiencemeans "who is this documentation written for". A person's note does not belong there.TaskNoteis scoped to a task — it requirestaskId.Shape
Modelled on schema.org/NoteDigitalDocument, so the semantics are familiar outside W3DS, but the identity and time fields follow this registry's convention rather than schema.org's —
id/createdAt/authorENameinstead ofdateCreated/author— because all 30 existing schemas name them that way and a reader here should not have to special-case one type. The mapping is stated in the schema description.Deliberately domain-level and general: what a note is about goes in
about/keywords, never into a narrower type. A note about paint and a note about a bike ride are the same kind of thing, and splitting them by subject is how vocabulary fragments.Two fields worth calling out:
derivedRecords— references to records extracted from the note (a purchase read off a photographed letter, a product identified in it), each carryingconfidencewhen it was inferred rather than read verbatim. The note stays authoritative for what was actually said: a derived reading can be wrong and redone, the original cannot.capturedBy— the eName of the application that recorded it, so a reader can tell an app-assisted capture from a hand-typed one.additionalProperties: true, followingcommunityActivityandsocialMediaPost.Context
Written for Nootropic, where a person hands over a photo, a voice note or a document and expects the meaning to be findable years later. Their utterance is stored as a
PersonalNoteand anything structured we extract references it. It is published in our self-description at/.well-known/w3ds-platform.jsonwithregistered: falseuntil this merges — the flag is checked against this registry at request time rather than maintained by hand.Happy to rename fields or drop
derivedRecords/capturedByif you would rather keep the type minimal.Summary by CodeRabbit
PersonalNoteschema.