You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ap...@apache.org on 2017/08/09 16:56:44 UTC
[7/8] atlas-website git commit: Updated with latest V2 API docs
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/index.html
----------------------------------------------------------------------
diff --git a/api/v2/index.html b/api/v2/index.html
index 6f95e61..e784603 100644
--- a/api/v2/index.html
+++ b/api/v2/index.html
@@ -52,6 +52,7 @@
<ul class="nav nav-sidebar">
<li><a href="#resources">Resources</a></li>
<li><a href="#syntax_json">JSON</a></li>
+ <li><a href="#syntax_xml">XML</a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -92,11 +93,13 @@
<tr class="clickable-row" data-href="resource_DiscoveryREST.html">
<td> <span class="resource-name">DiscoveryREST</span>
</td>
- <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/basic</span>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/attribute</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/basic</span>
</samp></li><li><samp> <span class="resource-path">/v2/search/dsl</span>
</samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
@@ -118,7 +121,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
-</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
@@ -135,6 +138,18 @@
<td> <span class="resource-description">REST interface for an entity's lineage information</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="resource_RelationshipREST.html">
+ <td> <span class="resource-name">RelationshipREST</span>
+</td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/relationship</span>
+</samp></li><li><samp> <span class="resource-path">/v2/relationship/guid/{guid}</span>
+</samp></li></ul></td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
+</samp></li></ul></td>
+ <td> <span class="resource-description">REST interface for entity relationships.</span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="resource_TypesREST.html">
<td> <span class="resource-name">TypesREST</span>
</td>
@@ -146,6 +161,8 @@
</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/guid/{guid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span>
@@ -163,6 +180,8 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description">REST interface for CRUD operations on type definitions</span>
</td>
@@ -185,13 +204,13 @@
<tr class="clickable-row" data-href="json_AtlasAttributeDef.html">
<td> <span class="datatype-name">AtlasAttributeDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-attribute.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html">
<td> <span class="datatype-name">AtlasBaseTypeDef</span>
</td>
- <td> <span class="datatype-description">Common-attributes for all Atlas types.</span>
+ <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassification.html">
@@ -203,7 +222,7 @@
<tr class="clickable-row" data-href="json_AtlasClassificationDef.html">
<td> <span class="datatype-name">AtlasClassificationDef</span>
</td>
- <td> <span class="datatype-description">Details of a classification-type.</span>
+ <td> <span class="datatype-description">class that captures details of a classification-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassifications.html">
@@ -215,31 +234,31 @@
<tr class="clickable-row" data-href="json_AtlasConstraintDef.html">
<td> <span class="datatype-name">AtlasConstraintDef</span>
</td>
- <td> <span class="datatype-description">Details of a constraint.</span>
+ <td> <span class="datatype-description">class that captures details of a constraint.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span>
</td>
- <td> <span class="datatype-description">List of Atlas entity along with the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntity.html">
<td> <span class="datatype-name">AtlasEntity</span>
</td>
- <td> <span class="datatype-description">Atlas entity representation</span>
+ <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityDef.html">
<td> <span class="datatype-name">AtlasEntityDef</span>
</td>
- <td> <span class="datatype-description">Details of an entity-type.</span>
+ <td> <span class="datatype-description">class that captures details of a entity-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html">
<td> <span class="datatype-name">AtlasEntityExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity representation along with extended info which included the entities being referred to</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityHeader.html">
@@ -251,109 +270,179 @@
<tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntityWithExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity with information about the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumDef.html">
<td> <span class="datatype-name">AtlasEnumDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-type.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumElementDef.html">
<td> <span class="datatype-name">AtlasEnumElementDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-element.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-element.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasFullTextResult.html">
<td> <span class="datatype-name">AtlasFullTextResult</span>
</td>
- <td> <span class="datatype-description">Search results for FullText APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasLineageInfo.html">
<td> <span class="datatype-name">AtlasLineageInfo</span>
</td>
- <td> <span class="datatype-description">Lineage information for a single entity</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasObjectId.html">
+ <td> <span class="datatype-name">AtlasObjectId</span>
+</td>
+ <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasQueryType.html">
<td> <span class="datatype-name">AtlasQueryType</span>
</td>
- <td> <span class="datatype-description">Various querying mechanisms supported by Atlas</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationship.html">
+ <td> <span class="datatype-name">AtlasRelationship</span>
+</td>
+ <td> <span class="datatype-description">Atlas relationship instance.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipDef</span>
+</td>
+ <td> <span class="datatype-description">AtlasRelationshipDef is a TypeDef that defines a relationship.
+
+As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.
+The name and the guid are the 2 ways that the RelationshipDef is identified.
+
+RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally
+whether the end is a container.
+RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
+RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
+RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.
+
+The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs
+will not specify an EntityDef type name as their types.
+
+RelationshipDefs introduce new atributes to the entity instances. For example
+EntityDef A might have attributes attr1,attr2,attr3
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef AtoB might define 2 ends
+end1: type A, name attr7
+end1: type B, name attr8
+
+When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
+
+In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into
+the entity instances</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipEndDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipEndDef</span>
+</td>
+ <td> <span class="datatype-description">The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an
+attribute name, cardinality and whether it is the container end of the relationship.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasSearchResult.html">
<td> <span class="datatype-name">AtlasSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results of the Discovery APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStruct.html">
<td> <span class="datatype-name">AtlasStruct</span>
</td>
- <td> <span class="datatype-description">Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStructDef.html">
<td> <span class="datatype-name">AtlasStructDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-type.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html">
<td> <span class="datatype-name">AtlasTypeDefHeader</span>
</td>
- <td> <span class="datatype-description">Minimal set of information about a type definition</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypesDef.html">
<td> <span class="datatype-name">AtlasTypesDef</span>
</td>
- <td> <span class="datatype-description">A collection of atlas enum, struct, classification and entity definitions (models).</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AttributeSearchResult.html">
<td> <span class="datatype-name">AttributeSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results for attribute(s)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Cardinality.html">
<td> <span class="datatype-name">Cardinality</span>
</td>
- <td> <span class="datatype-description">Cardinality of an attribute i.e. single-valued or multi-valued.</span>
+ <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html">
<td> <span class="datatype-name">ClassificationAssociateRequest</span>
</td>
- <td> <span class="datatype-description">Tag association request for a list of entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Condition.html">
+ <td> <span class="datatype-name">Condition</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityMutationResponse.html">
<td> <span class="datatype-name">EntityMutationResponse</span>
</td>
- <td> <span class="datatype-description">Entity modification response. Contains entity headers for each successful modification (create/update/delete)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityOperation.html">
<td> <span class="datatype-name">EntityOperation</span>
</td>
- <td> <span class="datatype-description">Entity operations supported by Atlas via REST</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_FilterCriteria.html">
+ <td> <span class="datatype-name">FilterCriteria</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageDirection.html">
<td> <span class="datatype-name">LineageDirection</span>
</td>
- <td> <span class="datatype-description">Lineage direction</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageRelation.html">
<td> <span class="datatype-name">LineageRelation</span>
</td>
- <td> <span class="datatype-description">Lineage relation between two entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Operator.html">
+ <td> <span class="datatype-name">Operator</span>
+</td>
+ <td> <span class="datatype-description">Supported search operations
+Logical comparision operators can only be used with numbers or dates
+IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_PList.html">
@@ -362,22 +451,109 @@
<td> <span class="datatype-description">Paginated-list, for returning search results.</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="json_PropagateTags.html">
+ <td> <span class="datatype-name">PropagateTags</span>
+</td>
+ <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance.
+Tags can propagate:
+NONE - not at all
+ONE_TO_TWO - from end 1 to 2
+TWO_TO_ONE - from end 2 to 1
+BOTH - both ways
+
+Care needs to be taken when specifying. The use cases we are aware of where this flag is useful:
+
+- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here
+- propagating classifications around Glossary synonyms - BOTH could be used here.
+
+There is an expectation that further enhancements will allow more granular control of tag propagation and will
+address how to resolve conflicts.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_RelationshipCategory.html">
+ <td> <span class="datatype-name">RelationshipCategory</span>
+</td>
+ <td> <span class="datatype-description">The Relationship category determines the style of relationship around containment and lifecycle.
+UML terminology is used for the values.
+ASSOCIATION is a relationship with no containment.
+COMPOSITION and AGGREGATION are containment relationships.
+The difference being in the lifecycles of the container and its children. In the COMPOSITION case,
+the children cannot exist without the container. For AGGREGATION, the life cycles
+of the container and children are totally independant.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_SearchParameters.html">
+ <td> <span class="datatype-name">SearchParameters</span>
+</td>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="json_SortType.html">
<td> <span class="datatype-name">SortType</span>
</td>
- <td> <span class="datatype-description">Type of sorting to be applied on the result set, defaults to NONE</span>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Status.html">
<td> <span class="datatype-name">Status</span>
</td>
- <td> <span class="datatype-description">Status of the entity - can be active or deleted.</span>
+ <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html">
+ <td> <span class="datatype-name">Status</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_TypeCategory.html">
<td> <span class="datatype-name">TypeCategory</span>
</td>
- <td> <span class="datatype-description">Category of a defined type</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3>
+
+ <table class="table table-hover datatypes">
+ <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption>
+ <thead>
+ <tr>
+ <th align="center">type</th>
+ <th align="center">description</th>
+ </tr>
+ </thead>
+ <tbody data-link="row" class="rowlink">
+ <tr class="clickable-row" data-href="xml_ns0_PList.html">
+ <td> <span class="datatype-name">PList</span>
+</td>
+ <td> <span class="datatype-description">Paginated-list, for returning search results.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_searchFilter.html">
+ <td> <span class="datatype-name">searchFilter</span>
+</td>
+ <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_sortType.html">
+ <td> <span class="datatype-name">sortType</span>
+</td>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html">
+ <td> <span class="datatype-name">atlasClassification</span>
+</td>
+ <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html">
+ <td> <span class="datatype-name">atlasStruct</span>
+</td>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasAttributeDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasAttributeDef.html b/api/v2/json_AtlasAttributeDef.html
index ec24df2..974b43d 100644
--- a/api/v2/json_AtlasAttributeDef.html
+++ b/api/v2/json_AtlasAttributeDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasAttributeDef <small>Data Type</small></h1>
- <p>Details of a struct-attribute.</p>
+ <p>class that captures details of a struct-attribute.</p>
<dl class="dl-horizontal">
</dl>
@@ -151,6 +151,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">defaultValue</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">constraints</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_AtlasConstraintDef.html">AtlasConstraintDef</a>
@@ -173,6 +182,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasBaseTypeDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasBaseTypeDef.html b/api/v2/json_AtlasBaseTypeDef.html
index eee5ce3..c7fe833 100644
--- a/api/v2/json_AtlasBaseTypeDef.html
+++ b/api/v2/json_AtlasBaseTypeDef.html
@@ -63,13 +63,13 @@
<h1 class="page-header">AtlasBaseTypeDef <small>Data Type</small></h1>
- <p>Common-attributes for all Atlas types.</p>
+ <p>Base class that captures common-attributes for all Atlas types.</p>
<dl class="dl-horizontal">
<dt>Abstract Type</dt>
<dd></dd>
<dt>Subtypes</dt>
- <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
+ <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
</dl>
<table class="table datatype-properties">
@@ -189,7 +189,7 @@
<div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div>
<pre class="prettyprint language-js example">{
- "category" : "PRIMITIVE",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasClassificationDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasClassificationDef.html b/api/v2/json_AtlasClassificationDef.html
index ceeb8d3..69a58b7 100644
--- a/api/v2/json_AtlasClassificationDef.html
+++ b/api/v2/json_AtlasClassificationDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasClassificationDef <small>Data Type</small></h1>
- <p>Details of a classification-type.</p>
+ <p>class that captures details of a classification-type.</p>
<dl class="dl-horizontal">
</dl>
@@ -180,11 +180,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -207,6 +208,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -221,7 +223,7 @@
}
} ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasConstraintDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasConstraintDef.html b/api/v2/json_AtlasConstraintDef.html
index ebbdd5c..cdbfec0 100644
--- a/api/v2/json_AtlasConstraintDef.html
+++ b/api/v2/json_AtlasConstraintDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasConstraintDef <small>Data Type</small></h1>
- <p>Details of a constraint.</p>
+ <p>class that captures details of a constraint.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntitiesWithExtInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntitiesWithExtInfo.html b/api/v2/json_AtlasEntitiesWithExtInfo.html
index efb5642..5ce3fab 100644
--- a/api/v2/json_AtlasEntitiesWithExtInfo.html
+++ b/api/v2/json_AtlasEntitiesWithExtInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntitiesWithExtInfo <small>Data Type</small></h1>
- <p>List of Atlas entity along with the referred entities</p>
+ <p>An instance of an entity along with extended info - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
</dl>
@@ -106,12 +106,16 @@
<pre class="prettyprint language-js example">{
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -132,12 +136,16 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -166,6 +174,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -193,6 +205,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntity.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntity.html b/api/v2/json_AtlasEntity.html
index d277898..f0554e3 100644
--- a/api/v2/json_AtlasEntity.html
+++ b/api/v2/json_AtlasEntity.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntity <small>Data Type</small></h1>
- <p>Atlas entity representation</p>
+ <p>An instance of an entity - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
</dl>
@@ -142,6 +142,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">relationshipAttributes</span>
+</td>
+ <td> <span class="datatype-reference">map of object
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">classifications</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a>
@@ -174,12 +183,16 @@
<pre class="prettyprint language-js example">{
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityDef.html b/api/v2/json_AtlasEntityDef.html
index e9757bf..98ddd09 100644
--- a/api/v2/json_AtlasEntityDef.html
+++ b/api/v2/json_AtlasEntityDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntityDef <small>Data Type</small></h1>
- <p>Details of an entity-type.</p>
+ <p>class that captures details of a entity-type.</p>
<dl class="dl-horizontal">
</dl>
@@ -180,11 +180,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -207,6 +208,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -221,7 +223,7 @@
}
} ]
} ],
- "category" : "MAP",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityExtInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityExtInfo.html b/api/v2/json_AtlasEntityExtInfo.html
index 6fd0dd4..218f53a 100644
--- a/api/v2/json_AtlasEntityExtInfo.html
+++ b/api/v2/json_AtlasEntityExtInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntityExtInfo <small>Data Type</small></h1>
- <p>Entity representation along with extended info which included the entities being referred to</p>
+ <p>An instance of an entity along with extended info - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
@@ -98,12 +98,16 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -131,6 +135,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityHeader.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityHeader.html b/api/v2/json_AtlasEntityHeader.html
index 77999b9..b255a32 100644
--- a/api/v2/json_AtlasEntityHeader.html
+++ b/api/v2/json_AtlasEntityHeader.html
@@ -138,7 +138,7 @@
<pre class="prettyprint language-js example">{
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityWithExtInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityWithExtInfo.html b/api/v2/json_AtlasEntityWithExtInfo.html
index d3cd2a8..688b940 100644
--- a/api/v2/json_AtlasEntityWithExtInfo.html
+++ b/api/v2/json_AtlasEntityWithExtInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntityWithExtInfo <small>Data Type</small></h1>
- <p>Entity with information about the referred entities</p>
+ <p>An instance of an entity along with extended info - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
</dl>
@@ -106,12 +106,16 @@
<pre class="prettyprint language-js example">{
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -134,12 +138,16 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -167,6 +175,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEnumDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEnumDef.html b/api/v2/json_AtlasEnumDef.html
index 44cd237..af3de9f 100644
--- a/api/v2/json_AtlasEnumDef.html
+++ b/api/v2/json_AtlasEnumDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEnumDef <small>Data Type</small></h1>
- <p>Details of an enum-type.</p>
+ <p>class that captures details of an enum-type.</p>
<dl class="dl-horizontal">
</dl>
@@ -183,7 +183,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "MAP",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEnumElementDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEnumElementDef.html b/api/v2/json_AtlasEnumElementDef.html
index e076a77..768d224 100644
--- a/api/v2/json_AtlasEnumElementDef.html
+++ b/api/v2/json_AtlasEnumElementDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEnumElementDef <small>Data Type</small></h1>
- <p>Details of an enum-element.</p>
+ <p>class that captures details of an enum-element.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasFullTextResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasFullTextResult.html b/api/v2/json_AtlasFullTextResult.html
index eaa271a..e8f99f4 100644
--- a/api/v2/json_AtlasFullTextResult.html
+++ b/api/v2/json_AtlasFullTextResult.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasFullTextResult <small>Data Type</small></h1>
- <p>Search results for FullText APIs</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasLineageInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasLineageInfo.html b/api/v2/json_AtlasLineageInfo.html
index 65291d6..f73150a 100644
--- a/api/v2/json_AtlasLineageInfo.html
+++ b/api/v2/json_AtlasLineageInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasLineageInfo <small>Data Type</small></h1>
- <p>Lineage information for a single entity</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -133,7 +133,7 @@
"guidEntityMap" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -144,7 +144,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -161,7 +161,7 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "BOTH",
+ "lineageDirection" : "INPUT",
"lineageDepth" : 12345
}</pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasObjectId.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasObjectId.html b/api/v2/json_AtlasObjectId.html
index a39f7cf..e1bd8c3 100644
--- a/api/v2/json_AtlasObjectId.html
+++ b/api/v2/json_AtlasObjectId.html
@@ -105,42 +105,6 @@
<td> <span class="property-description"></span>
</td>
</tr>
- <tr>
- <td> <span class="property-name">validGuid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
- <tr>
- <td> <span class="property-name">assignedGuid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
- <tr>
- <td> <span class="property-name">unAssignedGuid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
- <tr>
- <td> <span class="property-name">valid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
</tbody>
</table>
@@ -152,11 +116,7 @@
"uniqueAttributes" : {
"property1" : { },
"property2" : { }
- },
- "validGuid" : true,
- "assignedGuid" : true,
- "unAssignedGuid" : true,
- "valid" : true
+ }
}</pre>
<footer class="footer">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasQueryType.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasQueryType.html b/api/v2/json_AtlasQueryType.html
index 7161d50..71a2707 100644
--- a/api/v2/json_AtlasQueryType.html
+++ b/api/v2/json_AtlasQueryType.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasQueryType <small>Data Type</small></h1>
- <p>Various querying mechanisms supported by Atlas</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -93,6 +93,10 @@
<td><span class="value-value">BASIC</span></td>
<td><span class="value-description"></span></td>
</tr>
+ <tr>
+ <td><span class="value-value">ATTRIBUTE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasRelationship.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasRelationship.html b/api/v2/json_AtlasRelationship.html
new file mode 100644
index 0000000..5d9086e
--- /dev/null
+++ b/api/v2/json_AtlasRelationship.html
@@ -0,0 +1,256 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+
+ <title>Atlas REST API: AtlasRelationship</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelationship</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav navbar-right">
+ <li><a href="resources.html">Resources</a></li>
+ <li><a href="data.html">Data Types</a></li>
+ </ul>
+ </div>
+ </div>
+ </nav>
+
+ <div class="container-fluid">
+ <div class="row">
+ <div class="col-sm-3 col-md-2 sidebar" id="apinav">
+ <ul class="nav nav-sidebar">
+ <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
+ </ul>
+ </div>
+
+ <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
+ <ol class="breadcrumb" id="top">
+ <li class="active dropdown"><a href="index.html">Home</a></li>
+ <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasRelationship.html">AtlasRelationship</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasRelationship <small>Data Type</small></h1>
+
+ <p>Atlas relationship instance.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">guid</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">status</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_Status_AtlasRelationship.html">Status</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">createdBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">updatedBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">createTime</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">updateTime</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">version</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">end1</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">end2</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">label</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasStruct.html">AtlasStruct</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">typeName</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">attributes</span></td>
+ <td><span class="datatype-reference">map of object
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasRelationshipDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasRelationshipDef.html b/api/v2/json_AtlasRelationshipDef.html
new file mode 100644
index 0000000..e47b6a0
--- /dev/null
+++ b/api/v2/json_AtlasRelationshipDef.html
@@ -0,0 +1,350 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+
+ <title>Atlas REST API: AtlasRelationshipDef</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelationshipDef</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav navbar-right">
+ <li><a href="resources.html">Resources</a></li>
+ <li><a href="data.html">Data Types</a></li>
+ </ul>
+ </div>
+ </div>
+ </nav>
+
+ <div class="container-fluid">
+ <div class="row">
+ <div class="col-sm-3 col-md-2 sidebar" id="apinav">
+ <ul class="nav nav-sidebar">
+ <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
+ </ul>
+ </div>
+
+ <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
+ <ol class="breadcrumb" id="top">
+ <li class="active dropdown"><a href="index.html">Home</a></li>
+ <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasRelationshipDef <small>Data Type</small></h1>
+
+ <p>AtlasRelationshipDef is a TypeDef that defines a relationship.
+
+As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.
+The name and the guid are the 2 ways that the RelationshipDef is identified.
+
+RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally
+whether the end is a container.
+RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
+RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
+RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.
+
+The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs
+will not specify an EntityDef type name as their types.
+
+RelationshipDefs introduce new atributes to the entity instances. For example
+EntityDef A might have attributes attr1,attr2,attr3
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef AtoB might define 2 ends
+end1: type A, name attr7
+end1: type B, name attr8
+
+When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
+
+In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into
+the entity instances</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">relationshipCategory</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_RelationshipCategory.html">RelationshipCategory</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">propagateTags</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_PropagateTags.html">PropagateTags</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">endDef1</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">endDef2</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">relationshipLabel</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasStructDef.html">AtlasStructDef</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">attributeDefs</span></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasAttributeDef.html">AtlasAttributeDef</a>
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">category</span></td>
+ <td><span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a>
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">guid</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createdBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updatedBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updateTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">version</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">name</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">description</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">typeVersion</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">options</span></td>
+ <td><span class="datatype-reference">map of string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ } ],
+ "category" : "STRUCT",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasRelationshipEndDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasRelationshipEndDef.html b/api/v2/json_AtlasRelationshipEndDef.html
new file mode 100644
index 0000000..998d349
--- /dev/null
+++ b/api/v2/json_AtlasRelationshipEndDef.html
@@ -0,0 +1,171 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+
+ <title>Atlas REST API: AtlasRelationshipEndDef</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelationshipEndDef</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav navbar-right">
+ <li><a href="resources.html">Resources</a></li>
+ <li><a href="data.html">Data Types</a></li>
+ </ul>
+ </div>
+ </div>
+ </nav>
+
+ <div class="container-fluid">
+ <div class="row">
+ <div class="col-sm-3 col-md-2 sidebar" id="apinav">
+ <ul class="nav nav-sidebar">
+ <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
+ </ul>
+ </div>
+
+ <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
+ <ol class="breadcrumb" id="top">
+ <li class="active dropdown"><a href="index.html">Home</a></li>
+ <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasRelationshipEndDef <small>Data Type</small></h1>
+
+ <p>The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an
+attribute name, cardinality and whether it is the container end of the relationship.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">type</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">name</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">isContainer</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">cardinality</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_Cardinality.html">Cardinality</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">isLegacyAttribute</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasSearchResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasSearchResult.html b/api/v2/json_AtlasSearchResult.html
index 6ec8144..0b95d99 100644
--- a/api/v2/json_AtlasSearchResult.html
+++ b/api/v2/json_AtlasSearchResult.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasSearchResult <small>Data Type</small></h1>
- <p>Search results of the Discovery APIs</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -88,6 +88,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">searchParameters</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">queryText</span>
</td>
<td> <span class="datatype-reference">string
@@ -141,19 +150,51 @@
<td> <span class="property-description"></span>
</td>
</tr>
+ <tr>
+ <td> <span class="property-name">referredEntities</span>
+</td>
+ <td> <span class="datatype-reference">map of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
- "queryType" : "BASIC",
+ "queryType" : "ATTRIBUTE",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -163,7 +204,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -202,7 +243,31 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}</pre>
<footer class="footer">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasStruct.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStruct.html b/api/v2/json_AtlasStruct.html
index ac84929..5fe86c3 100644
--- a/api/v2/json_AtlasStruct.html
+++ b/api/v2/json_AtlasStruct.html
@@ -63,11 +63,11 @@
<h1 class="page-header">AtlasStruct <small>Data Type</small></h1>
- <p>Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</p>
+ <p>Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
- <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasEntity.html">AtlasEntity</a>, <a href="json_AtlasClassification.html">AtlasClassification</a></dd>
+ <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasEntity.html">AtlasEntity</a>, <a href="json_AtlasClassification.html">AtlasClassification</a>, <a href="json_AtlasRelationship.html">AtlasRelationship</a></dd>
</dl>
<table class="table datatype-properties">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasStructDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStructDef.html b/api/v2/json_AtlasStructDef.html
index 2012978..04c153e 100644
--- a/api/v2/json_AtlasStructDef.html
+++ b/api/v2/json_AtlasStructDef.html
@@ -63,11 +63,11 @@
<h1 class="page-header">AtlasStructDef <small>Data Type</small></h1>
- <p>Details of a struct-type.</p>
+ <p>class that captures details of a struct-type.</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
- <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
+ <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
</dl>
<table class="table datatype-properties">
@@ -170,11 +170,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -192,11 +193,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -211,7 +213,7 @@
}
} ]
} ],
- "category" : "ENUM",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasTypeDefHeader.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasTypeDefHeader.html b/api/v2/json_AtlasTypeDefHeader.html
index 3e12199..7a24dbb 100644
--- a/api/v2/json_AtlasTypeDefHeader.html
+++ b/api/v2/json_AtlasTypeDefHeader.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasTypeDefHeader <small>Data Type</small></h1>
- <p>Minimal set of information about a type definition</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -113,7 +113,7 @@
<pre class="prettyprint language-js example">{
"guid" : "...",
"name" : "...",
- "category" : "ENUM"
+ "category" : "STRUCT"
}</pre>
<footer class="footer">