Updaetd V2 REST API documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/commit/d3bcb175 Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/tree/d3bcb175 Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/diff/d3bcb175 Branch: refs/heads/asf-site Commit: d3bcb1751b390a24893cf0a8a5cdd1c1e46748cc Parents: 4164eb0 Author: Madhan Neethiraj <[email protected]> Authored: Sun Feb 19 21:28:08 2017 -0800 Committer: Madhan Neethiraj <[email protected]> Committed: Sun Feb 19 22:17:15 2017 -0800 ---------------------------------------------------------------------- api/v2/data.html | 188 +- api/v2/index.html | 188 +- api/v2/json_AtlasBaseTypeDef.html | 2 +- api/v2/json_AtlasClassificationDef.html | 4 +- api/v2/json_AtlasClassifications.html | 2 +- api/v2/json_AtlasEntitiesWithExtInfo.html | 60 +- api/v2/json_AtlasEntity.html | 43 +- api/v2/json_AtlasEntityDef.html | 2 +- api/v2/json_AtlasEntityExtInfo.html | 30 +- api/v2/json_AtlasEntityHeader.html | 21 - api/v2/json_AtlasEntityWithExtInfo.html | 46 +- api/v2/json_AtlasEnumDef.html | 2 +- api/v2/json_AtlasFullTextResult.html | 14 +- api/v2/json_AtlasLineageInfo.html | 26 +- api/v2/json_AtlasSearchResult.html | 32 +- api/v2/json_AtlasStructDef.html | 4 +- api/v2/json_AtlasTypeDefHeader.html | 2 +- api/v2/json_AtlasTypesDef.html | 32 +- api/v2/json_EntityMutationResponse.html | 196 +- api/v2/ns0.xsd | 570 +++ api/v2/resource_DiscoveryREST.html | 58 +- api/v2/resource_EntityREST.html | 1440 +------- api/v2/resource_LineageREST.html | 28 +- api/v2/resource_TypesREST.html | 226 +- api/v2/syntax_json.html | 6 - api/v2/syntax_xml.html | 182 + api/v2/ui/swagger.json | 3275 +++++++----------- api/v2/xml_ns0_atlasAttributeDef.html | 302 ++ api/v2/xml_ns0_atlasBaseTypeDef.html | 324 ++ api/v2/xml_ns0_atlasClassification.html | 159 + api/v2/xml_ns0_atlasClassificationDef.html | 310 ++ api/v2/xml_ns0_atlasConstraintDef.html | 166 + api/v2/xml_ns0_atlasEntity.html | 314 ++ api/v2/xml_ns0_atlasEntityDef.html | 310 ++ api/v2/xml_ns0_atlasEntityHeader.html | 235 ++ api/v2/xml_ns0_atlasEnumDef.html | 305 ++ api/v2/xml_ns0_atlasEnumElementDef.html | 185 + api/v2/xml_ns0_atlasFullTextResult.html | 173 + api/v2/xml_ns0_atlasLineageInfo.html | 226 ++ api/v2/xml_ns0_atlasObjectId.html | 185 + api/v2/xml_ns0_atlasQueryType.html | 130 + api/v2/xml_ns0_atlasSearchResult.html | 241 ++ api/v2/xml_ns0_atlasStruct.html | 168 + api/v2/xml_ns0_atlasStructDef.html | 297 ++ api/v2/xml_ns0_atlasTypeDefHeader.html | 185 + api/v2/xml_ns0_atlasTypesDef.html | 249 ++ api/v2/xml_ns0_attributeSearchResult.html | 166 + api/v2/xml_ns0_cardinality.html | 130 + .../xml_ns0_classificationAssociateRequest.html | 169 + api/v2/xml_ns0_entityMutationResponse.html | 166 + api/v2/xml_ns0_entityMutations.html | 127 + api/v2/xml_ns0_entityOperation.html | 134 + api/v2/xml_ns0_guidMapping.html | 149 + api/v2/xml_ns0_lineageDirection.html | 130 + api/v2/xml_ns0_lineageRelation.html | 166 + api/v2/xml_ns0_status.html | 126 + api/v2/xml_ns0_typeCategory.html | 150 + 57 files changed, 8565 insertions(+), 4191 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/data.html ---------------------------------------------------------------------- diff --git a/api/v2/data.html b/api/v2/data.html index 3eacea5..4b8ad51 100644 --- a/api/v2/data.html +++ b/api/v2/data.html @@ -171,12 +171,6 @@ <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> @@ -311,6 +305,188 @@ <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_typeCategory.html"> + <td> <span class="datatype-name">typeCategory</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasSearchResult.html"> + <td> <span class="datatype-name">atlasSearchResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasFullTextResult.html"> + <td> <span class="datatype-name">atlasFullTextResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasQueryType.html"> + <td> <span class="datatype-name">atlasQueryType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_attributeSearchResult.html"> + <td> <span class="datatype-name">attributeSearchResult</span> +</td> + <td> <span class="datatype-description"></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_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="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> + <tr class="clickable-row" data-href="xml_ns0_classificationAssociateRequest.html"> + <td> <span class="datatype-name">classificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_entityMutationResponse.html"> + <td> <span class="datatype-name">entityMutationResponse</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_entityMutations.html"> + <td> <span class="datatype-name">entityMutations</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_entityOperation.html"> + <td> <span class="datatype-name">entityOperation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_guidMapping.html"> + <td> <span class="datatype-name">guidMapping</span> +</td> + <td> <span class="datatype-description">This stores a mapping of guid assignments that were made during the processing +of a create or update entity request. +.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasLineageInfo.html"> + <td> <span class="datatype-name">atlasLineageInfo</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_lineageDirection.html"> + <td> <span class="datatype-name">lineageDirection</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_lineageRelation.html"> + <td> <span class="datatype-name">lineageRelation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_atlasTypeDefHeader.html"> + <td> <span class="datatype-name">atlasTypeDefHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasTypesDef.html"> + <td> <span class="datatype-name">atlasTypesDef</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> </tbody> </table> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/index.html ---------------------------------------------------------------------- diff --git a/api/v2/index.html b/api/v2/index.html index 9748c92..7a75783 100644 --- a/api/v2/index.html +++ b/api/v2/index.html @@ -277,12 +277,6 @@ <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> @@ -417,6 +411,188 @@ <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_typeCategory.html"> + <td> <span class="datatype-name">typeCategory</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasSearchResult.html"> + <td> <span class="datatype-name">atlasSearchResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasFullTextResult.html"> + <td> <span class="datatype-name">atlasFullTextResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasQueryType.html"> + <td> <span class="datatype-name">atlasQueryType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_attributeSearchResult.html"> + <td> <span class="datatype-name">attributeSearchResult</span> +</td> + <td> <span class="datatype-description"></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_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="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> + <tr class="clickable-row" data-href="xml_ns0_classificationAssociateRequest.html"> + <td> <span class="datatype-name">classificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_entityMutationResponse.html"> + <td> <span class="datatype-name">entityMutationResponse</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_entityMutations.html"> + <td> <span class="datatype-name">entityMutations</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_entityOperation.html"> + <td> <span class="datatype-name">entityOperation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_guidMapping.html"> + <td> <span class="datatype-name">guidMapping</span> +</td> + <td> <span class="datatype-description">This stores a mapping of guid assignments that were made during the processing +of a create or update entity request. +.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasLineageInfo.html"> + <td> <span class="datatype-name">atlasLineageInfo</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_lineageDirection.html"> + <td> <span class="datatype-name">lineageDirection</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_lineageRelation.html"> + <td> <span class="datatype-name">lineageRelation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_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="xml_ns0_atlasTypeDefHeader.html"> + <td> <span class="datatype-name">atlasTypeDefHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasTypesDef.html"> + <td> <span class="datatype-name">atlasTypesDef</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> </tbody> </table> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasBaseTypeDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasBaseTypeDef.html b/api/v2/json_AtlasBaseTypeDef.html index d484076..f19e03a 100644 --- a/api/v2/json_AtlasBaseTypeDef.html +++ b/api/v2/json_AtlasBaseTypeDef.html @@ -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" : "ARRAY", + "category" : "MAP", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasClassificationDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasClassificationDef.html b/api/v2/json_AtlasClassificationDef.html index 35d1479..3fcfca3 100644 --- a/api/v2/json_AtlasClassificationDef.html +++ b/api/v2/json_AtlasClassificationDef.html @@ -202,7 +202,7 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SINGLE", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, @@ -221,7 +221,7 @@ } } ] } ], - "category" : "OBJECT_ID_TYPE", + "category" : "STRUCT", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasClassifications.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasClassifications.html b/api/v2/json_AtlasClassifications.html index 95e3bd3..f35b15a 100644 --- a/api/v2/json_AtlasClassifications.html +++ b/api/v2/json_AtlasClassifications.html @@ -129,7 +129,7 @@ "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, - "sortType" : "DESC", + "sortType" : "ASC", "sortBy" : "..." }</pre> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEntitiesWithExtInfo.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEntitiesWithExtInfo.html b/api/v2/json_AtlasEntitiesWithExtInfo.html index 83659fc..309b1c4 100644 --- a/api/v2/json_AtlasEntitiesWithExtInfo.html +++ b/api/v2/json_AtlasEntitiesWithExtInfo.html @@ -106,7 +106,7 @@ <pre class="prettyprint language-js example">{ "entities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, @@ -125,20 +125,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -165,20 +151,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -207,20 +179,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -229,7 +187,7 @@ }, "property2" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, @@ -248,20 +206,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEntity.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEntity.html b/api/v2/json_AtlasEntity.html index 3baaccd..31fafa5 100644 --- a/api/v2/json_AtlasEntity.html +++ b/api/v2/json_AtlasEntity.html @@ -150,33 +150,6 @@ <td> <span class="property-description"></span> </td> </tr> - <tr> - <td> <span class="property-name">unassigned</span> -</td> - <td> <span class="datatype-reference">boolean -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">assigned</span> -</td> - <td> <span class="datatype-reference">boolean -</span> -</td> - <td> <span class="property-description"></span> -</td> - </tr> - <tr> - <td> <span class="property-name">atlasObjectId</span> -</td> - <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</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> @@ -201,7 +174,7 @@ <pre class="prettyprint language-js example">{ "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, @@ -220,20 +193,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEntityDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEntityDef.html b/api/v2/json_AtlasEntityDef.html index 6ac681b..3ba95c6 100644 --- a/api/v2/json_AtlasEntityDef.html +++ b/api/v2/json_AtlasEntityDef.html @@ -221,7 +221,7 @@ } } ] } ], - "category" : "ENTITY", + "category" : "CLASSIFICATION", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEntityExtInfo.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEntityExtInfo.html b/api/v2/json_AtlasEntityExtInfo.html index ad3b25c..8d37f38 100644 --- a/api/v2/json_AtlasEntityExtInfo.html +++ b/api/v2/json_AtlasEntityExtInfo.html @@ -98,7 +98,7 @@ "referredEntities" : { "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, @@ -117,20 +117,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -158,20 +144,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEntityHeader.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEntityHeader.html b/api/v2/json_AtlasEntityHeader.html index bc84234..77999b9 100644 --- a/api/v2/json_AtlasEntityHeader.html +++ b/api/v2/json_AtlasEntityHeader.html @@ -114,15 +114,6 @@ <td> <span class="property-description"></span> </td> </tr> - <tr> - <td> <span class="property-name">atlasObjectId</span> -</td> - <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</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> @@ -150,18 +141,6 @@ "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEntityWithExtInfo.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEntityWithExtInfo.html b/api/v2/json_AtlasEntityWithExtInfo.html index a759ab4..c28c05a 100644 --- a/api/v2/json_AtlasEntityWithExtInfo.html +++ b/api/v2/json_AtlasEntityWithExtInfo.html @@ -106,7 +106,7 @@ <pre class="prettyprint language-js example">{ "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, @@ -125,20 +125,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -167,20 +153,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -189,7 +161,7 @@ }, "property2" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, @@ -208,20 +180,6 @@ "property2" : { } } } ], - "unassigned" : true, - "assigned" : true, - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasEnumDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasEnumDef.html b/api/v2/json_AtlasEnumDef.html index bc81e81..06b7e28 100644 --- a/api/v2/json_AtlasEnumDef.html +++ b/api/v2/json_AtlasEnumDef.html @@ -183,7 +183,7 @@ "ordinal" : 12345 } ], "defaultValue" : "...", - "category" : "STRUCT", + "category" : "ENTITY", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasFullTextResult.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasFullTextResult.html b/api/v2/json_AtlasFullTextResult.html index 1eeae75..9da325d 100644 --- a/api/v2/json_AtlasFullTextResult.html +++ b/api/v2/json_AtlasFullTextResult.html @@ -104,21 +104,9 @@ <pre class="prettyprint language-js example">{ "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasLineageInfo.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasLineageInfo.html b/api/v2/json_AtlasLineageInfo.html index b509663..f1307a6 100644 --- a/api/v2/json_AtlasLineageInfo.html +++ b/api/v2/json_AtlasLineageInfo.html @@ -136,18 +136,6 @@ "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -159,18 +147,6 @@ "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -185,7 +161,7 @@ "fromEntityId" : "...", "toEntityId" : "..." } ], - "lineageDirection" : "OUTPUT", + "lineageDirection" : "BOTH", "lineageDepth" : 12345 }</pre> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasSearchResult.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasSearchResult.html b/api/v2/json_AtlasSearchResult.html index 5a601a2..79bf7e6 100644 --- a/api/v2/json_AtlasSearchResult.html +++ b/api/v2/json_AtlasSearchResult.html @@ -130,24 +130,12 @@ <pre class="prettyprint language-js example">{ "queryText" : "...", - "queryType" : "DSL", + "queryType" : "GREMLIN", "entities" : [ { "guid" : "...", "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -158,18 +146,6 @@ "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -183,10 +159,9 @@ "fullTextResult" : [ { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -197,10 +172,9 @@ }, { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasStructDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasStructDef.html b/api/v2/json_AtlasStructDef.html index 35cac2f..039d60c 100644 --- a/api/v2/json_AtlasStructDef.html +++ b/api/v2/json_AtlasStructDef.html @@ -170,7 +170,7 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SINGLE", + "cardinality" : "SET", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, @@ -211,7 +211,7 @@ } } ] } ], - "category" : "ARRAY", + "category" : "ENTITY", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasTypeDefHeader.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasTypeDefHeader.html b/api/v2/json_AtlasTypeDefHeader.html index 954d7a1..0d4e1a8 100644 --- a/api/v2/json_AtlasTypeDefHeader.html +++ b/api/v2/json_AtlasTypeDefHeader.html @@ -113,7 +113,7 @@ <pre class="prettyprint language-js example">{ "guid" : "...", "name" : "...", - "category" : "ENUM" + "category" : "PRIMITIVE" }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_AtlasTypesDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasTypesDef.html b/api/v2/json_AtlasTypesDef.html index a08594b..cc3388a 100644 --- a/api/v2/json_AtlasTypesDef.html +++ b/api/v2/json_AtlasTypesDef.html @@ -140,7 +140,7 @@ "ordinal" : 12345 } ], "defaultValue" : "...", - "category" : "OBJECT_ID_TYPE", + "category" : "MAP", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -185,7 +185,7 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SET", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, @@ -195,14 +195,14 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "SINGLE", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, "constraints" : [ { }, { } ] } ], - "category" : "ARRAY", + "category" : "STRUCT", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -221,7 +221,7 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, @@ -238,7 +238,7 @@ "isIndexable" : true, "constraints" : [ { }, { } ] } ], - "category" : "PRIMITIVE", + "category" : "ENTITY", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -269,14 +269,14 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SINGLE", + "cardinality" : "SET", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, "constraints" : [ { }, { } ] } ], - "category" : "OBJECT_ID_TYPE", + "category" : "PRIMITIVE", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -296,7 +296,7 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SET", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, @@ -306,14 +306,14 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, "constraints" : [ { }, { } ] } ], - "category" : "MAP", + "category" : "CLASSIFICATION", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -334,7 +334,7 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SET", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, @@ -344,14 +344,14 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "SINGLE", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, "constraints" : [ { }, { } ] } ], - "category" : "ENUM", + "category" : "MAP", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -381,14 +381,14 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SINGLE", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, "constraints" : [ { }, { } ] } ], - "category" : "ENTITY", + "category" : "MAP", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/json_EntityMutationResponse.html ---------------------------------------------------------------------- diff --git a/api/v2/json_EntityMutationResponse.html b/api/v2/json_EntityMutationResponse.html index 87b1ddb..265eb38 100644 --- a/api/v2/json_EntityMutationResponse.html +++ b/api/v2/json_EntityMutationResponse.html @@ -168,21 +168,9 @@ "mutatedEntities" : { "property1" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -193,18 +181,6 @@ "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -213,21 +189,9 @@ } ], "property2" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -235,21 +199,9 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -266,18 +218,6 @@ "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -285,21 +225,9 @@ } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -308,21 +236,9 @@ } ], "updatedEntities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -333,18 +249,6 @@ "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -356,18 +260,6 @@ "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -375,21 +267,9 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -398,21 +278,9 @@ } ], "deletedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -420,21 +288,9 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -446,18 +302,6 @@ "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -469,18 +313,6 @@ "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, @@ -492,18 +324,6 @@ "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], - "atlasObjectId" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - }, - "validGuid" : true, - "assignedGuid" : true, - "unAssignedGuid" : true, - "valid" : true - }, "typeName" : "...", "attributes" : { "property1" : { }, http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/d3bcb175/api/v2/ns0.xsd ---------------------------------------------------------------------- diff --git a/api/v2/ns0.xsd b/api/v2/ns0.xsd index b2b4f44..f0a2142 100644 --- a/api/v2/ns0.xsd +++ b/api/v2/ns0.xsd @@ -5,6 +5,30 @@ <xs:element name="PList" type="PList"/> <xs:element name="searchFilter" type="searchFilter"/> + <xs:element name="atlasSearchResult" type="atlasSearchResult"/> + <xs:element name="atlasFullTextResult" type="atlasFullTextResult"/> + <xs:element name="attributeSearchResult" type="attributeSearchResult"/> + <xs:element name="atlasClassification" type="atlasClassification"/> + <xs:element name="atlasEntity" type="atlasEntity"/> + <xs:element name="atlasEntityHeader" type="atlasEntityHeader"/> + <xs:element name="atlasObjectId" type="atlasObjectId"/> + <xs:element name="atlasStruct" type="atlasStruct"/> + <xs:element name="classificationAssociateRequest" type="classificationAssociateRequest"/> + <xs:element name="entityMutationResponse" type="entityMutationResponse"/> + <xs:element name="entityMutations" type="entityMutations"/> + <xs:element name="guidMapping" type="guidMapping"/> + <xs:element name="atlasLineageInfo" type="atlasLineageInfo"/> + <xs:element name="lineageRelation" type="lineageRelation"/> + <xs:element name="atlasBaseTypeDef" type="atlasBaseTypeDef"/> + <xs:element name="atlasClassificationDef" type="atlasClassificationDef"/> + <xs:element name="atlasEntityDef" type="atlasEntityDef"/> + <xs:element name="atlasEnumDef" type="atlasEnumDef"/> + <xs:element name="atlasEnumElementDef" type="atlasEnumElementDef"/> + <xs:element name="atlasStructDef" type="atlasStructDef"/> + <xs:element name="atlasAttributeDef" type="atlasAttributeDef"/> + <xs:element name="atlasConstraintDef" type="atlasConstraintDef"/> + <xs:element name="atlasTypeDefHeader" type="atlasTypeDefHeader"/> + <xs:element name="atlasTypesDef" type="atlasTypesDef"/> <xs:complexType name="PList"> <xs:annotation> <xs:documentation> @@ -77,4 +101,550 @@ </xs:restriction> </xs:simpleType> +<xs:simpleType name="typeCategory"> + <xs:restriction base="xs:string"> + + <xs:enumeration value="PRIMITIVE"/> + + <xs:enumeration value="OBJECT_ID_TYPE"/> + + <xs:enumeration value="ENUM"/> + + <xs:enumeration value="STRUCT"/> + + <xs:enumeration value="CLASSIFICATION"/> + + <xs:enumeration value="ENTITY"/> + + <xs:enumeration value="ARRAY"/> + + <xs:enumeration value="MAP"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="atlasSearchResult"> + <xs:sequence> + <xs:element name="queryText" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="queryType" type="atlasQueryType" minOccurs="0"> + </xs:element> + <xs:element name="entities" type="atlasEntityHeader" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="attributes" type="attributeSearchResult" minOccurs="0"> + </xs:element> + <xs:element name="fullTextResult" type="atlasFullTextResult" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasFullTextResult"> + <xs:sequence> + <xs:element name="entity" type="atlasEntityHeader" minOccurs="0"> + </xs:element> + <xs:element name="score" type="xs:double" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:simpleType name="atlasQueryType"> + <xs:restriction base="xs:string"> + + <xs:enumeration value="DSL"/> + + <xs:enumeration value="FULL_TEXT"/> + + <xs:enumeration value="GREMLIN"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="attributeSearchResult"> + <xs:sequence> + <xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="values" type="xs:anyType" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasClassification"> + <xs:annotation> + <xs:documentation> + <![CDATA[An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStruct"> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasEntity"> + <xs:annotation> + <xs:documentation> + <![CDATA[An instance of an entity - like hive_table, hive_database.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStruct"> + <xs:sequence> + <xs:element name="guid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="status" type="status" minOccurs="0"> + </xs:element> + <xs:element name="createdBy" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="updatedBy" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="createTime" type="xs:dateTime" minOccurs="0"> + </xs:element> + <xs:element name="updateTime" type="xs:dateTime" minOccurs="0"> + </xs:element> + <xs:element name="version" type="xs:long" minOccurs="0"> + </xs:element> + <xs:element name="classifications" type="atlasClassification" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:simpleType name="status"> + <xs:annotation> + <xs:documentation> + <![CDATA[Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.]]> + </xs:documentation> + </xs:annotation> + <xs:restriction base="xs:string"> + + <xs:enumeration value="ACTIVE"/> + + <xs:enumeration value="DELETED"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="atlasEntityHeader"> + <xs:annotation> + <xs:documentation> + <![CDATA[An instance of an entity - like hive_table, hive_database.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStruct"> + <xs:sequence> + <xs:element name="guid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="status" type="status" minOccurs="0"> + </xs:element> + <xs:element name="displayText" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="classificationNames" type="xs:string" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasObjectId"> + <xs:annotation> + <xs:documentation> + <![CDATA[Reference to an object-instance of an Atlas type - like entity.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="guid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="typeName" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="uniqueAttributes" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasStruct"> + <xs:annotation> + <xs:documentation> + <![CDATA[Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="typeName" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="attributes" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="classificationAssociateRequest"> + <xs:sequence> + <xs:element name="classification" type="atlasClassification" minOccurs="0"> + </xs:element> + <xs:element name="entityGuids" type="xs:string" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="entityMutationResponse"> + <xs:sequence> + <xs:element name="mutatedEntities" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="entityOperation"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + <xs:element name="guidAssignments" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:string"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="entityMutations"> + </xs:complexType> + +<xs:simpleType name="entityOperation"> + <xs:restriction base="xs:string"> + + <xs:enumeration value="CREATE"/> + + <xs:enumeration value="UPDATE"/> + + <xs:enumeration value="PARTIAL_UPDATE"/> + + <xs:enumeration value="DELETE"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="guidMapping"> + <xs:annotation> + <xs:documentation> + <![CDATA[This stores a mapping of guid assignments that were made during the processing +of a create or update entity request. +.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="guidAssignments" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:string"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasLineageInfo"> + <xs:sequence> + <xs:element name="baseEntityGuid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="guidEntityMap" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="atlasEntityHeader"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + <xs:element name="relations" type="lineageRelation" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="lineageDirection" type="lineageDirection" minOccurs="0"> + </xs:element> + <xs:element name="lineageDepth" type="xs:int" minOccurs="1"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:simpleType name="lineageDirection"> + <xs:restriction base="xs:string"> + + <xs:enumeration value="INPUT"/> + + <xs:enumeration value="OUTPUT"/> + + <xs:enumeration value="BOTH"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="lineageRelation"> + <xs:sequence> + <xs:element name="fromEntityId" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="toEntityId" type="xs:string" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasBaseTypeDef" abstract="true"> + <xs:annotation> + <xs:documentation> + <![CDATA[Base class that captures common-attributes for all Atlas types.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="guid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="createdBy" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="updatedBy" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="createTime" type="xs:dateTime" minOccurs="0"> + </xs:element> + <xs:element name="updateTime" type="xs:dateTime" minOccurs="0"> + </xs:element> + <xs:element name="version" type="xs:long" minOccurs="0"> + </xs:element> + <xs:element name="name" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="description" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="typeVersion" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="options" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:string"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasClassificationDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of a classification-type.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStructDef"> + <xs:sequence> + <xs:element name="superTypes" type="xs:string" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasEntityDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of a entity-type.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStructDef"> + <xs:sequence> + <xs:element name="superTypes" type="xs:string" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasEnumDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of an enum-type.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasBaseTypeDef"> + <xs:sequence> + <xs:element name="elementDefs" type="atlasEnumElementDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="defaultValue" type="xs:string" minOccurs="0"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasEnumElementDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of an enum-element.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="value" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="description" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="ordinal" type="xs:int" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasStructDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of a struct-type.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasBaseTypeDef"> + <xs:sequence> + <xs:element name="attributeDefs" type="atlasAttributeDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:complexType name="atlasAttributeDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of a struct-attribute.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="name" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="typeName" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="isOptional" type="xs:boolean" minOccurs="1"> + </xs:element> + <xs:element name="cardinality" type="cardinality" minOccurs="0"> + </xs:element> + <xs:element name="valuesMinCount" type="xs:int" minOccurs="1"> + </xs:element> + <xs:element name="valuesMaxCount" type="xs:int" minOccurs="1"> + </xs:element> + <xs:element name="isUnique" type="xs:boolean" minOccurs="1"> + </xs:element> + <xs:element name="isIndexable" type="xs:boolean" minOccurs="1"> + </xs:element> + <xs:element name="constraints" type="atlasConstraintDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:simpleType name="cardinality"> + <xs:annotation> + <xs:documentation> + <![CDATA[single-valued attribute or multi-valued attribute.]]> + </xs:documentation> + </xs:annotation> + <xs:restriction base="xs:string"> + + <xs:enumeration value="SINGLE"/> + + <xs:enumeration value="LIST"/> + + <xs:enumeration value="SET"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="atlasConstraintDef"> + <xs:annotation> + <xs:documentation> + <![CDATA[class that captures details of a constraint.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="type" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="params" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasTypeDefHeader"> + <xs:sequence> + <xs:element name="guid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="name" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="category" type="typeCategory" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasTypesDef"> + <xs:sequence> + <xs:element name="enumDefs" type="atlasEnumDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="structDefs" type="atlasStructDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="classificationDefs" type="atlasClassificationDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="entityDefs" type="atlasEntityDef" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + </xs:sequence> +</xs:complexType> + </xs:schema> \ No newline at end of file
