[ https://issues.apache.org/jira/browse/ATLAS-2058?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Madhan Neethiraj updated ATLAS-2058: ------------------------------------ Fix Version/s: 1.0.0 Component/s: atlas-core > Add a description to every element that appears in TypeDefs > ------------------------------------------------------------ > > Key: ATLAS-2058 > URL: https://issues.apache.org/jira/browse/ATLAS-2058 > Project: Atlas > Issue Type: Improvement > Components: atlas-core > Reporter: David Radley > Assignee: David Radley > Priority: Major > Fix For: 1.0.0 > > Attachments: ATLAS2058.patch > > > It would be very useful to have a desciption for every element that appears > in the TypeDef. > This will be useful as we can document the meaning of each of each of the top > level defs. In the new top level types we are adding (e.g. in Jira 1836) we > can define exactly the intent of each entity, relationship, classification, > attribute and enum value. TypeDefs thjemselves already have descriptions. > We may need to think about restricting or escaping some characters that might > interfere with the json. At the description will be a quoted string, we may > be able to get away with supporting all characters apart from quotes. > Ideally we would support markup and embedded images. Short term I propose we > consider tolerating markup if it is easy to implement and look at embedded > images longer term. -- This message was sent by Atlassian JIRA (v7.6.3#76005)