Home

Suggestion

This is an abstract base type used in Stencila Schema for suggested document changes.

It exists to represent proposed edits as first-class nodes that can carry status, feedback, provenance, and original or replacement content. This supports review and model-assisted editing workflows that need suggestions to persist within the document model.

Key properties include the suggestion suggestionType, status, and any associated feedback or authorship metadata.

Analogues

The following external types, elements, or nodes are similar to a Suggestion:

  • word processor tracked change: Close editing analogue for persisted proposed changes, though Stencila suggestions are explicit typed nodes rather than markup overlays in a word-processing format.

Properties

The Suggestion type has these properties:

NameDescriptionTypeInherited from
suggestionTypeThe type of suggestion including whether it is an insertion or a deletion.SuggestionType-
suggestionStatusThe status of the suggestion including whether it is the original, or is accepted, or rejected.SuggestionStatus-
authorsThe authors of the suggestionAuthor*-
provenanceA summary of the provenance of the content within the suggestion.ProvenanceCount*-
datePublishedDate of the suggestion was created.DateTime-
executionDurationTime taken to generate the suggestion.Duration-
executionEndedThe timestamp when the generation ended.Timestamp-
feedbackFeedback on the suggestionString-
idThe identifier for this item.StringEntity

Related

The Suggestion type is related to these types:

Bindings

The Suggestion type is represented in:


This documentation was generated from Suggestion.yaml by docs_types.rs.

© 2026 Stencila