You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2018/06/03 20:58:54 UTC
[26/31] atlas-website git commit: ATLAS-2691: updated documentation
to add Downloads page
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/index.html
----------------------------------------------------------------------
diff --git a/api/v2/index.html b/api/v2/index.html
index e784603..80c4261 100644
--- a/api/v2/index.html
+++ b/api/v2/index.html
@@ -15,7 +15,7 @@
<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">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
@@ -50,9 +50,9 @@
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<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><a href="#resources"><abbr title="Resources"><span class="sideoverflow">Resources</span></abbr></a></li>
+ <li><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li>
+ <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</span></abbr></a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -97,11 +97,23 @@
</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><li><samp> <span class="resource-path">/v2/search/relationship</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/saved</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/saved/{guid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/saved/{name}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/{name}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/guid/{guid}</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><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> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</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 data discovery using dsl or full text search</span>
</td>
@@ -113,21 +125,75 @@
</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk</span>
</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/classification</span>
</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/entity/{guid}/audit</span>
</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classifications</span>
</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}</span>
</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications</span>
+</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><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">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>
</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><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>
</samp></li></ul></td>
<td> <span class="resource-description">REST for a single entity</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="resource_GlossaryREST.html">
+ <td> <span class="resource-name">GlossaryREST</span>
+</td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/glossary</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/categories</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/category</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/term</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/detailed</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/partial</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/partial</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/related</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/terms</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}/partial</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/related</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories/headers</span>
+</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms/headers</span>
+</samp></li></ul></td>
+ <td class="text-nowrap"><ul class="list-unstyled"><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">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">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">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> <span class="label label-default resource-method">PUT</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">PUT</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">PUT</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">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">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><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li></ul></td>
+ <td> <span class="resource-description"></span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="resource_LineageREST.html">
<td> <span class="resource-name">LineageREST</span>
</td>
@@ -201,291 +267,34 @@
</tr>
</thead>
<tbody data-link="row" class="rowlink">
- <tr class="clickable-row" data-href="json_AtlasAttributeDef.html">
- <td> <span class="datatype-name">AtlasAttributeDef</span>
-</td>
- <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">Base class that captures common-attributes for all Atlas types.</span>
-</td>
- </tr>
<tr class="clickable-row" data-href="json_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="json_AtlasClassificationDef.html">
- <td> <span class="datatype-name">AtlasClassificationDef</span>
-</td>
- <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">
- <td> <span class="datatype-name">AtlasClassifications</span>
-</td>
- <td> <span class="datatype-description">REST serialization friendly list.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="json_AtlasConstraintDef.html">
- <td> <span class="datatype-name">AtlasConstraintDef</span>
-</td>
- <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">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">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">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">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">
- <td> <span class="datatype-name">AtlasEntityHeader</span>
-</td>
- <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_AtlasEntityWithExtInfo.html">
- <td> <span class="datatype-name">AtlasEntityWithExtInfo</span>
-</td>
- <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">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">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"></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"></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"></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"></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">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">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"></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"></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"></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">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"></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"></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"></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"></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"></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">
<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="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>
+ <tr class="clickable-row" data-href="json_SearchFilter.html">
+ <td> <span class="datatype-name">SearchFilter</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> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_SortType.html">
@@ -494,22 +303,10 @@ of the container and children are totally independant.</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. 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>
+ <tr class="clickable-row" data-href="json_TimeBoundary.html">
+ <td> <span class="datatype-name">TimeBoundary</span>
</td>
- <td> <span class="datatype-description"></span>
+ <td> <span class="datatype-description">Captures time-boundary details</span>
</td>
</tr>
</tbody>
@@ -544,6 +341,12 @@ of the container and children are totally independant.</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="xml_ns0_timeBoundary.html">
+ <td> <span class="datatype-name">timeBoundary</span>
+</td>
+ <td> <span class="datatype-description">Captures time-boundary details</span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="xml_ns0_atlasClassification.html">
<td> <span class="datatype-name">atlasClassification</span>
</td>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/json_AtlasClassification.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasClassification.html b/api/v2/json_AtlasClassification.html
index b938209..e743429 100644
--- a/api/v2/json_AtlasClassification.html
+++ b/api/v2/json_AtlasClassification.html
@@ -15,7 +15,7 @@
<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">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
@@ -78,6 +78,33 @@
</tr>
</thead>
<tbody>
+ <tr>
+ <td> <span class="property-name">entityGuid</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">propagate</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">validityPeriods</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_TimeBoundary.html">TimeBoundary</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_AtlasStruct.html">AtlasStruct</a></h5></td>
@@ -101,6 +128,17 @@
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
"typeName" : "...",
"attributes" : {
"property1" : { },
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/json_AtlasStruct.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStruct.html b/api/v2/json_AtlasStruct.html
index 5fe86c3..34f0ba9 100644
--- a/api/v2/json_AtlasStruct.html
+++ b/api/v2/json_AtlasStruct.html
@@ -15,7 +15,7 @@
<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">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
@@ -67,7 +67,7 @@
<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>, <a href="json_AtlasRelationship.html">AtlasRelationship</a></dd>
+ <dd><a href="json_AtlasClassification.html">AtlasClassification</a></dd>
</dl>
<table class="table datatype-properties">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/json_ClassificationAssociateRequest.html
----------------------------------------------------------------------
diff --git a/api/v2/json_ClassificationAssociateRequest.html b/api/v2/json_ClassificationAssociateRequest.html
index 1cc02de..d139bce 100644
--- a/api/v2/json_ClassificationAssociateRequest.html
+++ b/api/v2/json_ClassificationAssociateRequest.html
@@ -15,7 +15,7 @@
<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">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
@@ -103,6 +103,17 @@
<pre class="prettyprint language-js example">{
"classification" : {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
"typeName" : "...",
"attributes" : {
"property1" : { },
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/json_PList.html
----------------------------------------------------------------------
diff --git a/api/v2/json_PList.html b/api/v2/json_PList.html
index 73e19a7..d30fdb9 100644
--- a/api/v2/json_PList.html
+++ b/api/v2/json_PList.html
@@ -15,7 +15,7 @@
<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">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/json_SearchFilter.html
----------------------------------------------------------------------
diff --git a/api/v2/json_SearchFilter.html b/api/v2/json_SearchFilter.html
new file mode 100644
index 0000000..15a6253
--- /dev/null
+++ b/api/v2/json_SearchFilter.html
@@ -0,0 +1,183 @@
+<!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: SearchFilter</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/enunciate.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: SearchFilter</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_SearchFilter.html">SearchFilter</a></li>
+ </ol>
+
+ <h1 class="page-header">SearchFilter <small>Data Type</small></h1>
+
+ <p>Generic filter, to specify search criteria using name/value pairs.</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">params</span>
+</td>
+ <td> <span class="datatype-reference">map of array of string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">startIndex</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">maxRows</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">getCount</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">sortBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">sortType</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "params" : {
+ "property1" : [ "...", "..." ],
+ "property2" : [ "...", "..." ]
+ },
+ "startIndex" : 12345,
+ "maxRows" : 12345,
+ "getCount" : true,
+ "sortBy" : "...",
+ "sortType" : "ASC"
+}</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/58bb55a6/api/v2/json_SortType.html
----------------------------------------------------------------------
diff --git a/api/v2/json_SortType.html b/api/v2/json_SortType.html
index aefc77b..84828ad 100644
--- a/api/v2/json_SortType.html
+++ b/api/v2/json_SortType.html
@@ -15,7 +15,7 @@
<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">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
@@ -50,6 +50,10 @@
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
+ <li><a href="#NONE"><abbr title="NONE"><span class="sideoverflow">NONE</span></abbr></a></li>
+ <li><a href="#ASC"><abbr title="ASC"><span class="sideoverflow">ASC</span></abbr></a></li>
+ <li><a href="#DESC"><abbr title="DESC"><span class="sideoverflow">DESC</span></abbr></a></li>
+ <li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
@@ -78,15 +82,15 @@
</thead>
<tbody>
<tr>
- <td><span class="value-value">NONE</span></td>
+ <td><span class="value-value" id="NONE">NONE</span></td>
<td><span class="value-description"></span></td>
</tr>
<tr>
- <td><span class="value-value">ASC</span></td>
+ <td><span class="value-value" id="ASC">ASC</span></td>
<td><span class="value-description"></span></td>
</tr>
<tr>
- <td><span class="value-value">DESC</span></td>
+ <td><span class="value-value" id="DESC">DESC</span></td>
<td><span class="value-description"></span></td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/json_TimeBoundary.html
----------------------------------------------------------------------
diff --git a/api/v2/json_TimeBoundary.html b/api/v2/json_TimeBoundary.html
new file mode 100644
index 0000000..3d9b5d5
--- /dev/null
+++ b/api/v2/json_TimeBoundary.html
@@ -0,0 +1,150 @@
+<!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: TimeBoundary</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/enunciate.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: TimeBoundary</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_TimeBoundary.html">TimeBoundary</a></li>
+ </ol>
+
+ <h1 class="page-header">TimeBoundary <small>Data Type</small></h1>
+
+ <p>Captures time-boundary details</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">startTime</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">endTime</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">timeZone</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+}</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/58bb55a6/api/v2/ns0.xsd
----------------------------------------------------------------------
diff --git a/api/v2/ns0.xsd b/api/v2/ns0.xsd
index cdb7997..f0a4003 100644
--- a/api/v2/ns0.xsd
+++ b/api/v2/ns0.xsd
@@ -5,6 +5,7 @@
<xs:element name="PList" type="PList"/>
<xs:element name="searchFilter" type="searchFilter"/>
+ <xs:element name="timeBoundary" type="timeBoundary"/>
<xs:element name="atlasClassification" type="atlasClassification"/>
<xs:element name="atlasStruct" type="atlasStruct"/>
<xs:complexType name="PList">
@@ -79,6 +80,22 @@
</xs:restriction>
</xs:simpleType>
+<xs:complexType name="timeBoundary">
+ <xs:annotation>
+ <xs:documentation>
+ <![CDATA[Captures time-boundary details]]>
+ </xs:documentation>
+ </xs:annotation>
+ <xs:sequence>
+ <xs:element name="startTime" type="xs:string" minOccurs="0">
+ </xs:element>
+ <xs:element name="endTime" type="xs:string" minOccurs="0">
+ </xs:element>
+ <xs:element name="timeZone" type="xs:string" minOccurs="0">
+ </xs:element>
+ </xs:sequence>
+</xs:complexType>
+
<xs:complexType name="atlasClassification">
<xs:annotation>
<xs:documentation>
@@ -87,6 +104,14 @@
</xs:annotation>
<xs:complexContent>
<xs:extension base="atlasStruct">
+ <xs:sequence>
+ <xs:element name="entityGuid" type="xs:string" minOccurs="0">
+ </xs:element>
+ <xs:element name="propagate" type="xs:boolean" minOccurs="0">
+ </xs:element>
+ <xs:element name="validityPeriods" type="timeBoundary" minOccurs="0" maxOccurs="unbounded">
+ </xs:element>
+ </xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>