You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@atlas.apache.org by "David Radley (JIRA)" <ji...@apache.org> on 2017/08/18 08:30:00 UTC

[jira] [Created] (ATLAS-2058) Add a description to every element that appears in TypeDefs

David Radley created ATLAS-2058:
-----------------------------------

             Summary: 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
            Reporter: David Radley
            Assignee: David Radley


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.

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.   




--
This message was sent by Atlassian JIRA
(v6.4.14#64029)