Skip to main content

​
Suggestion

This schema defines the Suggestion entity. A suggestion can be applied to an asset to give the owner context about possible changes or improvements to descriptions, tags,…

​
Properties

  • id: Unique identifier that identifies an entity instance. Refer to ../../type/basic.
  • type: Refer to #definitions.
  • href: Link to the resource corresponding to this entity. Refer to ../../type/basic.
  • entityLink: Data asset about which this thread is created for with format <#E::{entities}::{entityName}::{field}::{fieldValue}>. Refer to ../../type/basic.
  • createdAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.
  • createdBy: User or Bot who made the suggestion. Refer to ../../type/entityreference.
  • updatedAt: Last update time corresponding to the update version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.
  • updatedBy (string): User or Bot who updated the suggestion.
  • status: Refer to #definitions.
  • description (string): The main message of the thread in Markdown format.
  • tagLabels (array): Tags or Glossary Terms. Default: null.

​
Definitions

  • suggestionType (string): Type of a Suggestion. Must be one of: ["SuggestDescription", "SuggestTagLabel"].
  • suggestionStatus (string): Status of a Suggestion. Must be one of: ["Open", "Accepted", "Rejected"]. Default: "Open".
Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.