Revision
A version of a work in its history, such as a commit to a repository or a revision of a document or wiki page. It isPartOf the work and isBasedOn the versions before it. The UpdateAction whose result it is records making it. A revision is a version, not a change. Its change is how it differs from the versions it is based on.
Properties
| Property | Expected type | Description |
|---|---|---|
| From CreativeWork | ||
| author many | Agent | An agent who wrote the work, such as a person or a software assistant. |
| creator many | Agent | An agent who brought the work into being, such as by writing, producing, or releasing it. |
| dateCovered one | DateRange | A period the work is about, such as the day a journal entry describes, the month a recap covers, or the years a novel is set in. The action that created the work gives when it was written. |
| datePublished one | DateTime | When the work was published or released. It is when the work's PublishAction occurred. |
| genre many | Text | A genre of the work. |
| isBasedOn many | CreativeWork | A work this one was derived from, such as the earlier version a revision follows or the repository a fork was copied from. |
| publisher many | Organization | The organization that published the work. |
| references many | Entity | An entity this one refers to, such as one it @mentions, a page it links to, or a work it cites. |
| rendition many | MediaObject |
A file that holds the work, such as a picture's image file, a video's video file, or an episode's audio file. A work can have several, such as a picture's image and the short video captured with it, or the same picture in two formats. Seen from the file, the work is its renditionOf value.
|
| series many | CreativeWork | The series that this work is one of, such as the podcast an episode belongs to or the series a book was published in. |
| sourceFormat one | Text | The platform's own format for the work, among works of the same type. For example, a post can be a story, a feed post, or a reel, a video can be a short or a live stream, and a podcast episode can be a trailer or a bonus. Each source has its own values. A work has a sourceFormat only when its source has such formats. |
| visibility one | Text |
How widely the work is shared. It is one of public, private, or unlisted, and each source's audience settings map onto these. Not allowed: other values (friends) or other cases (Public).
|
| webFeed many | URL | The URL of an RSS or Atom feed that publishes the work's items, such as a podcast's episodes or a blog's posts. |
| From Entity | ||
| about many | Entity | What the entity is about, such as a topic or a tag. |
| alternateName many | Text | Another name the entity was shown with, such as the display name a message gave its sender or a recipient. An entity can have many. |
| body one | Text |
The text content of an entity, such as a shell command or a message. It is plain text or Markdown. Not allowed: HTML (<p>Hello</p>).
|
| category many | Text |
A text label that classifies the entity, such as breakfast for a Meal or car for a PhysicalObject.
|
| contains many | MediaObject | A media file that is part of the entity, such as an attachment to a Message, the photo in a Post, or the images and videos in a carousel. Each one has its most specific type, such as ImageObject. |
| description one | Text |
Text that describes an entity, such as a task's notes or a project's summary. It is plain text or Markdown. Not allowed: HTML (<p>Buy milk</p>).
|
| emblem one | ImageObject | The image an entity presents itself by, such as an avatar, a poster, a cover, a logo, or a favicon. It stands for the entity but is not its content, so changing it does not change the entity. It can be a photograph or any other image. Banners and headers are not emblems. |
| handle one | Text | An identifier for an entity within a namespace, such as a username, a channel slug, or a tag label. What it identifies depends on that namespace. |
| inAccount many | Agent or FinancialAccount | The account that holds the entity. For an account with a service, it is the agent whose account it is, as that service knows them, such as the owner of an email account a message was delivered to. For a FinancialAccount, it is the account itself, such as the one a FinancialPosting is on or a PaymentCard draws on. An entity held in several accounts is inAccount each. Identifiers an account issues are unique within it. |
| inRealm one | Realm | The realm the entity is in, such as the computer system that holds a conversation or a file. Identifiers local to the realm are unique within it. |
| isPartOf many | Entity |
A whole that the entity is part of, such as a task's project, the page an excerpt comes from, or the transaction a posting belongs to. Seen from the whole, its parts are its hasPart values.
|
| location one | Location or Place | Where the action happened, or where the entity or event is. |
| name one | Text | The name or title of an entity, such as a person's display name, a document's title, or a place's name. |
| references many | Entity | An entity this one refers to, such as one it @mentions, a page it links to, or a work it cites. |
| sameAs many | Entity or Text |
Another reference to the same entity, either an entity or a text reference such as @me. It states that both refer to one thing, not that they are similar or related.
|
| tags many | Text | A text label for the entity. A label that is an entity of its own is a Tag. |
| url one | URL | A URL at which the entity can be found, such as a web page's address or a link to the record in its source. |
| From Base | ||
| source one | Text |
The source that describes the entity or action, such as things-todo. Identifiers such as sourceId are unique within it.
|
| sourceId one | Text | The identifier the source gives an entity or action, such as a record ID or message ID. It is unique only within its source. |
Used as a value
A Revision can be the value of these properties.
- about on Entity · accepts any Entity
- composition on · accepts any Entity
- depicts on StillImage, MovingImage · accepts any Entity
- instrument on Action · accepts any Entity
- isBasedOn on CreativeWork · accepts any CreativeWork
- isPartOf on Entity · accepts any Entity
- likes on Agent · accepts any Entity
- memberOf on Agent · accepts any Entity
- mentions on · accepts any Entity
- object on Action · accepts any Entity
- partOf on · accepts any CreativeWork
- references on Entity, CreativeWork, Session · accepts any Entity
- relation on · accepts any Entity
- result on Action · accepts any Entity
- sameAs on Entity · accepts any Entity
- series on CreativeWork · accepts any CreativeWork
- snapshotOf on MediaObject · accepts any Entity
- subject on Session · accepts any Entity
- target on Action · accepts any Entity
URI https://schema.chronicle.app/Revision · Suggest a change