Suggestions API

[harshach]

Feature
Suggestions API to add descriptions and tags/glossary terms as suggestions.

Describe the task
OpenMetadata provides various collaboration aspects to enable data teams to contribute the data asset documentations through "Requests for Description", "Request for tags" etc.. Although these are great enablers, we are looking to make this process simpler for anyone to edit the description as a suggestion to improve the docs around data assets.

/api/v1/suggestions

POST

 "id": {
      "description": "Unique identifier that identifies an entity instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
  "suggestionType: {
      "enum": ["Description", "Tag", "GlossaryTerm"],
   },
 "entityLink": {
      "description": "Data asset about which this thread is created for with format <#E::{entities}::{entityName}::{field}::{fieldValue}.",
      "$ref": "../../type/basic.json#/definitions/entityLink"
    },
  "suggestedBy": {
     "$ref": "../../type/basic.json#/definitions/entityReference"
    },
   "description": {
       "$ref": "../../type/basic.json#/definitions/markdown"
     } ,
    "labels": {
      "description": "Tags or Glossary Terms.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },

List

/api/v1/suggestions?fqn=entityFQN&suggestedBy='user/bot'&includeChildren=true

passing entityFQN will bring only entity related suggestions, if includeChildren is passed it will return all suggestions for columns as well

pass suggestedBy to bring specific user or bot suggestions

Apply

POST

/api/v1/suggestions/apply/{id}

pass specific instance suggestion, checks the logged in users permission for EDIT_ALL, EDIT_DESCRIPTION,EDIT_TAGS before applying

/api/v1/suggestions/apply/{fqn}

pass FQN to apply suggestions by specific user/bot and additional parameters to apply to children. This will help apply suggestions at bulk.

Reject

POST

/api/v1/suggestions/reject/{id}

/api/v1/suggestions/reject/{fqn}