Updated with latest V2 API docs
Project: http://git-wip-us.apache.org/repos/asf/atlas-website/repo Commit: http://git-wip-us.apache.org/repos/asf/atlas-website/commit/f415335a Tree: http://git-wip-us.apache.org/repos/asf/atlas-website/tree/f415335a Diff: http://git-wip-us.apache.org/repos/asf/atlas-website/diff/f415335a Branch: refs/heads/asf-site Commit: f415335a8a47dd94c360bc8f13d4c813321e8d74 Parents: 2f9c0cb Author: apoorvnaik <apoorvn...@apache.org> Authored: Wed Aug 9 09:56:24 2017 -0700 Committer: apoorvnaik <apoorvn...@apache.org> Committed: Wed Aug 9 09:56:24 2017 -0700 ---------------------------------------------------------------------- Architecture.html | 8 +- Authentication-Authorization.html | 8 +- Bridge-Falcon.html | 8 +- Bridge-Hive.html | 8 +- Bridge-Sqoop.html | 8 +- Configuration.html | 8 +- EclipseSetup.html | 8 +- Export-API.html | 8 +- Export-HDFS-API.html | 8 +- HighAvailability.html | 8 +- Import-API-Options.html | 8 +- Import-API.html | 17 +- Import-Export-API.html | 8 +- InstallationSteps.html | 8 +- Notification-Entity.html | 8 +- QuickStart.html | 8 +- Repository.html | 8 +- Search.html | 220 +- Security.html | 8 +- StormAtlasHook.html | 8 +- TypeSystem.html | 8 +- api/v2/application.wadl | 157 + api/v2/data.html | 216 +- api/v2/index.html | 238 +- api/v2/json_AtlasAttributeDef.html | 12 +- api/v2/json_AtlasBaseTypeDef.html | 6 +- api/v2/json_AtlasClassificationDef.html | 8 +- api/v2/json_AtlasConstraintDef.html | 2 +- api/v2/json_AtlasEntitiesWithExtInfo.html | 22 +- api/v2/json_AtlasEntity.html | 17 +- api/v2/json_AtlasEntityDef.html | 8 +- api/v2/json_AtlasEntityExtInfo.html | 12 +- api/v2/json_AtlasEntityHeader.html | 2 +- api/v2/json_AtlasEntityWithExtInfo.html | 18 +- api/v2/json_AtlasEnumDef.html | 4 +- api/v2/json_AtlasEnumElementDef.html | 2 +- api/v2/json_AtlasFullTextResult.html | 2 +- api/v2/json_AtlasLineageInfo.html | 8 +- api/v2/json_AtlasObjectId.html | 42 +- api/v2/json_AtlasQueryType.html | 6 +- api/v2/json_AtlasRelationship.html | 256 + api/v2/json_AtlasRelationshipDef.html | 350 + api/v2/json_AtlasRelationshipEndDef.html | 171 + api/v2/json_AtlasSearchResult.html | 75 +- api/v2/json_AtlasStruct.html | 4 +- api/v2/json_AtlasStructDef.html | 12 +- api/v2/json_AtlasTypeDefHeader.html | 4 +- api/v2/json_AtlasTypesDef.html | 160 +- api/v2/json_AttributeSearchResult.html | 2 +- api/v2/json_Cardinality.html | 2 +- api/v2/json_ClassificationAssociateRequest.html | 2 +- api/v2/json_Condition.html | 122 + api/v2/json_EntityMutationResponse.html | 16 +- api/v2/json_EntityOperation.html | 2 +- api/v2/json_FilterCriteria.html | 182 + api/v2/json_LineageDirection.html | 2 +- api/v2/json_LineageRelation.html | 2 +- api/v2/json_Operator.html | 160 + api/v2/json_PList.html | 2 +- api/v2/json_PropagateTags.html | 143 + api/v2/json_RelationshipCategory.html | 132 + api/v2/json_SearchParameters.html | 222 + api/v2/json_SortType.html | 2 +- api/v2/json_Status.html | 2 +- api/v2/json_Status_AtlasRelationship.html | 122 + api/v2/json_TypeCategory.html | 6 +- api/v2/ns0.xsd | 530 -- api/v2/resource_DiscoveryREST.html | 613 +- api/v2/resource_EntityREST.html | 299 +- api/v2/resource_LineageREST.html | 6 +- api/v2/resource_RelationshipREST.html | 502 ++ api/v2/resource_TypesREST.html | 1552 ++++- api/v2/resources.html | 22 +- api/v2/syntax_json.html | 171 +- api/v2/syntax_xml.html | 170 - api/v2/ui/swagger.json | 6122 +++++++++++++----- api/v2/xml_ns0_PList.html | 242 + api/v2/xml_ns0_atlasClassification.html | 159 + api/v2/xml_ns0_atlasStruct.html | 168 + api/v2/xml_ns0_searchFilter.html | 242 + api/v2/xml_ns0_sortType.html | 130 + index.html | 8 +- issue-tracking.html | 8 +- license.html | 8 +- mail-lists.html | 8 +- project-info.html | 8 +- source-repository.html | 8 +- team-list.html | 173 +- 88 files changed, 11481 insertions(+), 2994 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Architecture.html ---------------------------------------------------------------------- diff --git a/Architecture.html b/Architecture.html index 9abd154..44de9e4 100644 --- a/Architecture.html +++ b/Architecture.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Architecture</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Authentication-Authorization.html ---------------------------------------------------------------------- diff --git a/Authentication-Authorization.html b/Authentication-Authorization.html index 7638fdd..6a46097 100644 --- a/Authentication-Authorization.html +++ b/Authentication-Authorization.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Authentication & Authorization in Apache Atlas.</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Bridge-Falcon.html ---------------------------------------------------------------------- diff --git a/Bridge-Falcon.html b/Bridge-Falcon.html index c53baa2..4bb8a0e 100644 --- a/Bridge-Falcon.html +++ b/Bridge-Falcon.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Falcon Atlas Bridge</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Bridge-Hive.html ---------------------------------------------------------------------- diff --git a/Bridge-Hive.html b/Bridge-Hive.html index 19d1ae1..e43aed9 100644 --- a/Bridge-Hive.html +++ b/Bridge-Hive.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Hive Atlas Bridge</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Bridge-Sqoop.html ---------------------------------------------------------------------- diff --git a/Bridge-Sqoop.html b/Bridge-Sqoop.html index d51307e..79b5eee 100644 --- a/Bridge-Sqoop.html +++ b/Bridge-Sqoop.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Sqoop Atlas Bridge</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Configuration.html ---------------------------------------------------------------------- diff --git a/Configuration.html b/Configuration.html index e422549..ff75f66 100644 --- a/Configuration.html +++ b/Configuration.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Configuring Apache Atlas - Application Properties</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/EclipseSetup.html ---------------------------------------------------------------------- diff --git a/EclipseSetup.html b/EclipseSetup.html index 3e58608..406804c 100644 --- a/EclipseSetup.html +++ b/EclipseSetup.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Tools required to build and run Apache Atlas on Eclipse</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Export-API.html ---------------------------------------------------------------------- diff --git a/Export-API.html b/Export-API.html index 75221cc..d8c3917 100644 --- a/Export-API.html +++ b/Export-API.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Export API</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Export-HDFS-API.html ---------------------------------------------------------------------- diff --git a/Export-HDFS-API.html b/Export-HDFS-API.html index 41b8e51..831f505 100644 --- a/Export-HDFS-API.html +++ b/Export-HDFS-API.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Export & Import APIs for HDFS Path</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/HighAvailability.html ---------------------------------------------------------------------- diff --git a/HighAvailability.html b/HighAvailability.html index b20622a..f56ca1a 100644 --- a/HighAvailability.html +++ b/HighAvailability.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Fault Tolerance and High Availability Options</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Import-API-Options.html ---------------------------------------------------------------------- diff --git a/Import-API-Options.html b/Import-API-Options.html index fb4db49..beb6b38 100644 --- a/Import-API-Options.html +++ b/Import-API-Options.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Import API Options</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Import-API.html ---------------------------------------------------------------------- diff --git a/Import-API.html b/Import-API.html index 6680fc3..4ab24fe 100644 --- a/Import-API.html +++ b/Import-API.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Import API</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> @@ -322,6 +322,15 @@ curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data "http://localhost:21000/api/atlas/admin/import" </pre></div> +<p>The <i>request</i> parameter is optional. If import has to be run without any options use:</p> +<div class="source"> +<pre> +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" + -H "Cache-Control: no-cache" + -F data=@quickStartDB.zip + "http://localhost:21000/api/atlas/admin/import" + +</pre></div> <p>The call below performs Import of <i>QuickStart</i> database using a ZIP file available on server.</p> <div class="source"> <pre> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Import-Export-API.html ---------------------------------------------------------------------- diff --git a/Import-Export-API.html b/Import-Export-API.html index 639d3b7..d337d21 100644 --- a/Import-Export-API.html +++ b/Import-Export-API.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Export & Import REST APIs</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/InstallationSteps.html ---------------------------------------------------------------------- diff --git a/InstallationSteps.html b/InstallationSteps.html index 09fd512..71bdec4 100644 --- a/InstallationSteps.html +++ b/InstallationSteps.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Building & Installing Apache Atlas</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Notification-Entity.html ---------------------------------------------------------------------- diff --git a/Notification-Entity.html b/Notification-Entity.html index c8c4deb..0316601 100644 --- a/Notification-Entity.html +++ b/Notification-Entity.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Entity Change Notifications</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/QuickStart.html ---------------------------------------------------------------------- diff --git a/QuickStart.html b/QuickStart.html index f597052..612e079 100644 --- a/QuickStart.html +++ b/QuickStart.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Quick Start Guide</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Repository.html ---------------------------------------------------------------------- diff --git a/Repository.html b/Repository.html index 9e220bb..f5bcbf5 100644 --- a/Repository.html +++ b/Repository.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Repository</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Search.html ---------------------------------------------------------------------- diff --git a/Search.html b/Search.html index 39bbc80..0c11db9 100644 --- a/Search.html +++ b/Search.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Search</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> @@ -218,10 +218,182 @@ <h2><a name="Search"></a>Search</h2> <p>Atlas exposes search over the metadata in two ways:</p> <ul> -<li>Search using DSL</li> -<li>Full-text search</li></ul></div> +<li>Basic Search</li> +<li>Advanced Search (DSL or Full-Text)</li></ul></div> <div class="section"> -<h3><a name="Search_DSL_Grammar"></a>Search DSL Grammar</h3> +<h3><a name="Basic_search"></a>Basic search</h3> +<p>The basic search allows you to query using typename of an entity, associated classification/tag and has support for filtering on the entity attribute(s) as well as the classification/tag attributes.</p> +<p>The entire query structure can be represented using the following JSON structure (called SearchParameters)</p> +<div class="source"> +<pre> +{ + "typeName": "hive_table", + "excludeDeletedEntities": true, + "classification" : "", + "query": "", + "limit": 25, + "offset": 0, + "entityFilters": { + "attributeName": "name", + "operator": "contains", + "attributeValue": "testtable" + }, + "tagFilters": null, + "attributes": [""] +} + +</pre></div> +<p><b><i>Field description</i></b></p> +<p></p> +<ul> +<li>typeName: The type of entity to look for</li> +<li>excludeDeletedEntities: Should the search include deleted entities too (default: true)</li> +<li>classification: Only include entities with given Classification/tag</li> +<li>query: Any free text occurrence that the entity should have (generic/wildcard queries might be slow)</li> +<li>limit: Max number of results to fetch</li> +<li>offset: Starting offset of the result set (useful for pagination)</li> +<li>entityFilters: Entity Attribute filter(s)</li> +<li>tagFilters: Classification/tag Attribute filter(s)</li> +<li>attributes: Attributes to include in the search result (default: include any attribute present in the filter)</li></ul> +<p>Attribute based filtering can be done on multiple attributes with AND/OR condition.</p> +<p><b>NOTE: The tagFilters and entityFilters field have same JSON structure.</b></p> +<p><b><i>Examples of filtering (for hive_table attributes)</i></b></p> +<ul> +<li>Single attribute</li></ul> +<div class="source"> +<pre> + { + "typeName": "hive_table", + "excludeDeletedEntities": true, + "classification" : "", + "query": "", + "limit": 50, + "offset": 0, + "entityFilters": { + "attributeName": "name", + "operator": "contains", + "attributeValue": "testtable" + }, + "tagFilters": null, + "attributes": [""] + } + +</pre></div> +<p></p> +<ul> +<li>Multi-attribute with OR</li></ul> +<div class="source"> +<pre> + { + "typeName": "hive_table", + "excludeDeletedEntities": true, + "classification" : "", + "query": "", + "limit": 50, + "offset": 0, + "entityFilters": { + "condition": "OR", + "criterion": [ + { + "attributeName": "name", + "operator": "contains", + "attributeValue": "testtable" + }, + { + "attributeName": "owner", + "operator": "eq", + "attributeValue": "admin" + } + ] + }, + "tagFilters": null, + "attributes": [""] + } + +</pre></div> +<p></p> +<ul> +<li>Multi-attribute with AND</li></ul> +<div class="source"> +<pre> + { + "typeName": "hive_table", + "excludeDeletedEntities": true, + "classification" : "", + "query": "", + "limit": 50, + "offset": 0, + "entityFilters": { + "condition": "AND", + "criterion": [ + { + "attributeName": "name", + "operator": "contains", + "attributeValue": "testtable" + }, + { + "attributeName": "owner", + "operator": "eq", + "attributeValue": "admin" + } + ] + }, + "tagFilters": null, + "attributes": [""] + } + +</pre></div> +<p><b><i>Supported operators for filtering</i></b></p> +<p></p> +<ul> +<li>LT (symbols: <, lt) works with Numeric, Date attributes</li> +<li>GT (symbols: >, gt) works with Numeric, Date attributes</li> +<li>LTE (symbols: <=, lte) works with Numeric, Date attributes</li> +<li>GTE (symbols: >=, gte) works with Numeric, Date attributes</li> +<li>EQ (symbols: eq, =) works with Numeric, Date, String attributes</li> +<li>NEQ (symbols: neq, !=) works with Numeric, Date, String attributes</li> +<li>LIKE (symbols: like, LIKE) works with String attributes</li> +<li>STARTS_WITH (symbols: startsWith, STARTSWITH) works with String attributes</li> +<li>ENDS_WITH (symbols: endsWith, ENDSWITH) works with String attributes</li> +<li>CONTAINS (symbols: contains, CONTAINS) works with String attributes</li></ul> +<p><b><i>CURL Samples</i></b></p> +<div class="source"> +<pre> + curl -sivk -g + -u <user>:<password> + -X POST + -d '{ + "typeName": "hive_table", + "excludeDeletedEntities": true, + "classification" : "", + "query": "", + "limit": 50, + "offset": 0, + "entityFilters": { + "condition": "AND", + "criterion": [ + { + "attributeName": "name", + "operator": "contains", + "attributeValue": "testtable" + }, + { + "attributeName": "owner", + "operator": "eq", + "attributeValue": "admin" + } + ] + }, + "tagFilters": null, + "attributes": [""] + }' + <protocol>://<atlas_host>:<atlas_port>/api/atlas/v2/search/basic + +</pre></div></div> +<div class="section"> +<h3><a name="Advanced_Search"></a>Advanced Search</h3></div> +<div class="section"> +<h4><a name="Search_DSL_Grammar"></a>Search DSL Grammar</h4> <p>The DSL exposes an SQL like query language for searching the metadata based on the type system. The grammar for the DSL is below.</p> <div class="source"> <pre> @@ -232,9 +404,9 @@ query: querySrc ~ opt(loopExpression) ~ opt(groupByExpr) ~ opt(selectClause) ~ o querySrc: rep1sep(singleQrySrc, opt(COMMA)) singleQrySrc = FROM ~ fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression) | - WHERE ~ (expr ^? notIdExpression) | - expr ^? notIdExpression | - fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression) + WHERE ~ (expr ^? notIdExpression) | + expr ^? notIdExpression | + fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression) fromSrc: identifier ~ AS ~ alias | identifier @@ -267,10 +439,10 @@ expr: compE ~ opt(rep(exprRight)) exprRight: (AND | OR) ~ compE compE: - arithE ~ (LT | LTE | EQ | NEQ | GT | GTE) ~ arithE | - arithE ~ (ISA | IS) ~ ident | - arithE ~ HAS ~ ident | - arithE | countClause | maxClause | minClause | sumClause + arithE ~ (LT | LTE | EQ | NEQ | GT | GTE) ~ arithE | + arithE ~ (ISA | IS) ~ ident | + arithE ~ HAS ~ ident | + arithE | countClause | maxClause | minClause | sumClause arithE: multiE ~ opt(rep(arithERight)) @@ -287,14 +459,14 @@ identifier: rep1sep(ident, DOT) alias: ident | stringLit literal: booleanConstant | - intConstant | - longConstant | - floatConstant | - doubleConstant | - stringLit + intConstant | + longConstant | + floatConstant | + doubleConstant | + stringLit </pre></div> -<p>Grammar language: {noformat} opt(a) => a is optional ~ => a combinator. 'a ~ b' means a followed by b rep => zero or more rep1sep => one or more, separated by second arg. {noformat}</p> +<p>Grammar language: {noformat} opt(a) => a is optional ~ => a combinator. 'a ~ b' means a followed by b rep => zero or more rep1sep => one or more, separated by second arg. {noformat}</p> <p>Language Notes:</p> <ul> <li>A <b>SingleQuery</b> expression can be used to search for entities of a <i>Trait</i> or <i>Class</i>.</li></ul>Entities can be filtered based on a 'Where Clause' and Entity Attributes can be retrieved based on a 'Select Clause'. @@ -310,13 +482,11 @@ literal: booleanConstant | <li>ORDERBY is optional. When order by clause is specified, case insensitive sorting is done based on the column specified.</li></ul>For sorting in descending order specify 'DESC' after order by clause. If no order by is specified, then no default sorting is applied. <ul> <li>LIMIT is optional. It limits the maximum number of objects to be fetched starting from specified optional offset. If no offset is specified count starts from beginning.</li> -<li>There are couple of Predicate functions different from SQL: +<li>There are couple of Predicate functions different from SQL:</li></ul>* <i>is</i> or <i>isa</i>can be used to filter Entities that have a particular Trait. * <i>has</i> can be used to filter Entities that have a value for a particular Attribute. <ul> -<li><i>is</i> or <i>isa</i>can be used to filter Entities that have a particular Trait.</li> -<li><i>has</i> can be used to filter Entities that have a value for a particular Attribute.</li></ul></li> <li>Any identifiers or constants with special characters(space,$,",{,}) should be enclosed within backquote (`)</li></ul></div> <div class="section"> -<h4><a name="DSL_Examples"></a>DSL Examples</h4> +<h5><a name="DSL_Examples"></a>DSL Examples</h5> <p>For the model, Asset - attributes name, owner, description DB - supertype Asset - attributes clusterName, parameters, comment Column - extends Asset - attributes type, comment Table - supertype Asset - db, columns, parameters, comment Traits - PII, Log Data</p> <p>DSL queries: * from DB</p> <ul> @@ -337,7 +507,7 @@ literal: booleanConstant | <li>from Person select count() as 'count', max(Person.age) as 'max', min(Person.age)</li> <li>`Log Data`</li></ul></div> <div class="section"> -<h3><a name="Full-text_Search"></a>Full-text Search</h3> +<h4><a name="Full-text_Search"></a>Full-text Search</h4> <p>Atlas also exposes a lucene style full-text search capability.</p></div> </div> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Security.html ---------------------------------------------------------------------- diff --git a/Security.html b/Security.html index 8a62041..e56df02 100644 --- a/Security.html +++ b/Security.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Security Features of Apache Atlas</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/StormAtlasHook.html ---------------------------------------------------------------------- diff --git a/StormAtlasHook.html b/StormAtlasHook.html index c09107b..ec82362 100644 --- a/StormAtlasHook.html +++ b/StormAtlasHook.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Storm Atlas Bridge</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/TypeSystem.html ---------------------------------------------------------------------- diff --git a/TypeSystem.html b/TypeSystem.html index eadfc65..820532d 100644 --- a/TypeSystem.html +++ b/TypeSystem.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-07-24 + | Generated by Apache Maven Doxia at 2017-08-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170724" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Atlas – Type System</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -204,8 +204,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li> + <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li> </ul> </div> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/application.wadl ---------------------------------------------------------------------- diff --git a/api/v2/application.wadl b/api/v2/application.wadl index 35a0d1c..e1002ae 100644 --- a/api/v2/application.wadl +++ b/api/v2/application.wadl @@ -5,6 +5,7 @@ <wadl:doc xmlns:enunciate="http://enunciate.webcohesion.com/"; enunciate:generatedBy="Enunciate-2.0"/> <wadl:grammars> + <wadl:include href="ns0.xsd"/> </wadl:grammars> <wadl:resources base="./"> @@ -24,6 +25,32 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:method> </wadl:resource> + <wadl:resource path="v2/relationship"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create a new relationship between entities.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/relationship"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Update an existing relationship between entities.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="v2/entity/bulk"> <wadl:method name="GET"> <wadl:doc><![CDATA[Bulk API to retrieve list of entities identified by its GUIDs.]]></wadl:doc> @@ -93,6 +120,36 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:param> </wadl:resource> + <wadl:resource path="v2/search/attribute"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Retrieve data for the specified attribute search query]]></wadl:doc> + <wadl:request> + <wadl:param name="attrName" style="query"> + <wadl:doc><![CDATA[Attribute name]]></wadl:doc> + </wadl:param> + <wadl:param name="attrValuePrefix" style="query"> + <wadl:doc><![CDATA[Attibute value to search on]]></wadl:doc> + </wadl:param> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> + </wadl:param> + <wadl:param name="typeName" style="query"> + <wadl:doc><![CDATA[limit the result to only entities of specified type or its sub-types]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[Invalid wildcard or query parameters]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Search results]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="v2/search/basic"> <wadl:method name="GET"> <wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc> @@ -100,6 +157,9 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:param name="classification" style="query"> <wadl:doc><![CDATA[limit the result to only entities tagged with the given classification or or its sub-types]]></wadl:doc> </wadl:param> + <wadl:param name="excludeDeletedEntities" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> <wadl:param name="limit" style="query"> <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> </wadl:param> @@ -123,6 +183,24 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:method> </wadl:resource> + <wadl:resource path="v2/search/basic"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Search parameters]]></wadl:doc> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="v2/search/dsl"> <wadl:method name="GET"> <wadl:doc><![CDATA[Retrieve data for the specified DSL]]></wadl:doc> @@ -157,6 +235,9 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:method name="GET"> <wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc> <wadl:request> + <wadl:param name="excludeDeletedEntities" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> <wadl:param name="limit" style="query"> <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> </wadl:param> @@ -301,6 +382,31 @@ Null updates are not possible]]></wadl:doc> </wadl:param> </wadl:resource> + <wadl:resource path="v2/relationship/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get relationship information between entities using guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/relationship/guid/{guid}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete a relationship between entities using guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + <wadl:resource path="v2/types/typedefs/headers"> <wadl:method name="GET"> <wadl:doc><![CDATA[Bulk retrieval API for all type definitions returned as a list of minimal information header]]></wadl:doc> @@ -339,6 +445,21 @@ Null updates are not possible]]></wadl:doc> </wadl:param> </wadl:resource> + <wadl:resource path="v2/entity/guid/{guid}/classifications"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Updates classifications to an existing entity represented by a guid.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + <wadl:representation mediaType="application/xml" element="atlasClassification"> + </wadl:representation> + </wadl:request> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + </wadl:param> + </wadl:resource> + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Fetch complete definition of an entity given its type and unique attribute.]]></wadl:doc> @@ -495,6 +616,42 @@ Null updates are not possible]]></wadl:doc> </wadl:param> </wadl:resource> + <wadl:resource path="v2/types/relationshipdef/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the relationship definition for the given guid]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[On Failed lookup for the given guid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[relationship definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[relationship guid]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/relationshipdef/name/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the relationship definition by it's name (unique)]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[On Failed lookup for the given name]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[relationship definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[relationship name]]></wadl:doc> + </wadl:param> + </wadl:resource> + <wadl:resource path="v2/types/structdef/guid/{guid}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the struct definition for the given guid]]></wadl:doc> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/data.html ---------------------------------------------------------------------- diff --git a/api/v2/data.html b/api/v2/data.html index c61a827..38aa078 100644 --- a/api/v2/data.html +++ b/api/v2/data.html @@ -51,6 +51,7 @@ <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> <li><a href="#syntax_json">JSON</a></li> + <li><a href="#syntax_xml">XML</a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> @@ -77,13 +78,13 @@ <tr class="clickable-row" data-href="json_AtlasAttributeDef.html"> <td> <span class="datatype-name">AtlasAttributeDef</span> </td> - <td> <span class="datatype-description">Details of a struct-attribute.</span> + <td> <span class="datatype-description">class that captures details of a struct-attribute.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html"> <td> <span class="datatype-name">AtlasBaseTypeDef</span> </td> - <td> <span class="datatype-description">Common-attributes for all Atlas types.</span> + <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasClassification.html"> @@ -95,7 +96,7 @@ <tr class="clickable-row" data-href="json_AtlasClassificationDef.html"> <td> <span class="datatype-name">AtlasClassificationDef</span> </td> - <td> <span class="datatype-description">Details of a classification-type.</span> + <td> <span class="datatype-description">class that captures details of a classification-type.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasClassifications.html"> @@ -107,31 +108,31 @@ <tr class="clickable-row" data-href="json_AtlasConstraintDef.html"> <td> <span class="datatype-name">AtlasConstraintDef</span> </td> - <td> <span class="datatype-description">Details of a constraint.</span> + <td> <span class="datatype-description">class that captures details of a constraint.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html"> <td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span> </td> - <td> <span class="datatype-description">List of Atlas entity along with the referred entities</span> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEntity.html"> <td> <span class="datatype-name">AtlasEntity</span> </td> - <td> <span class="datatype-description">Atlas entity representation</span> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEntityDef.html"> <td> <span class="datatype-name">AtlasEntityDef</span> </td> - <td> <span class="datatype-description">Details of an entity-type.</span> + <td> <span class="datatype-description">class that captures details of a entity-type.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html"> <td> <span class="datatype-name">AtlasEntityExtInfo</span> </td> - <td> <span class="datatype-description">Entity representation along with extended info which included the entities being referred to</span> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> @@ -143,109 +144,179 @@ <tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html"> <td> <span class="datatype-name">AtlasEntityWithExtInfo</span> </td> - <td> <span class="datatype-description">Entity with information about the referred entities</span> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEnumDef.html"> <td> <span class="datatype-name">AtlasEnumDef</span> </td> - <td> <span class="datatype-description">Details of an enum-type.</span> + <td> <span class="datatype-description">class that captures details of an enum-type.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasEnumElementDef.html"> <td> <span class="datatype-name">AtlasEnumElementDef</span> </td> - <td> <span class="datatype-description">Details of an enum-element.</span> + <td> <span class="datatype-description">class that captures details of an enum-element.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasFullTextResult.html"> <td> <span class="datatype-name">AtlasFullTextResult</span> </td> - <td> <span class="datatype-description">Search results for FullText APIs</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasLineageInfo.html"> <td> <span class="datatype-name">AtlasLineageInfo</span> </td> - <td> <span class="datatype-description">Lineage information for a single entity</span> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasQueryType.html"> <td> <span class="datatype-name">AtlasQueryType</span> </td> - <td> <span class="datatype-description">Various querying mechanisms supported by Atlas</span> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationship.html"> + <td> <span class="datatype-name">AtlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationshipDef.html"> + <td> <span class="datatype-name">AtlasRelationshipDef</span> +</td> + <td> <span class="datatype-description">AtlasRelationshipDef is a TypeDef that defines a relationship. + +As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. +The name and the guid are the 2 ways that the RelationshipDef is identified. + +RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally +whether the end is a container. +RelationshipDefs can have AttributeDefs - though only primitive types are allowed. +RelationshipDefs have a relationshipCategory specifying the UML type of relationship required +RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships. + +The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs +will not specify an EntityDef type name as their types. + +RelationshipDefs introduce new atributes to the entity instances. For example +EntityDef A might have attributes attr1,attr2,attr3 +EntityDef B might have attributes attr4,attr5,attr6 +RelationshipDef AtoB might define 2 ends +end1: type A, name attr7 +end1: type B, name attr8 + +When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 +When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8 + +In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into +the entity instances</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationshipEndDef.html"> + <td> <span class="datatype-name">AtlasRelationshipEndDef</span> +</td> + <td> <span class="datatype-description">The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasSearchResult.html"> <td> <span class="datatype-name">AtlasSearchResult</span> </td> - <td> <span class="datatype-description">Search results of the Discovery APIs</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasStruct.html"> <td> <span class="datatype-name">AtlasStruct</span> </td> - <td> <span class="datatype-description">Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasStructDef.html"> <td> <span class="datatype-name">AtlasStructDef</span> </td> - <td> <span class="datatype-description">Details of a struct-type.</span> + <td> <span class="datatype-description">class that captures details of a struct-type.</span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html"> <td> <span class="datatype-name">AtlasTypeDefHeader</span> </td> - <td> <span class="datatype-description">Minimal set of information about a type definition</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_AtlasTypesDef.html"> <td> <span class="datatype-name">AtlasTypesDef</span> </td> - <td> <span class="datatype-description">A collection of atlas enum, struct, classification and entity definitions (models).</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_AttributeSearchResult.html"> <td> <span class="datatype-name">AttributeSearchResult</span> </td> - <td> <span class="datatype-description">Search results for attribute(s)</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_Cardinality.html"> <td> <span class="datatype-name">Cardinality</span> </td> - <td> <span class="datatype-description">Cardinality of an attribute i.e. single-valued or multi-valued.</span> + <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span> </td> </tr> <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> <td> <span class="datatype-name">ClassificationAssociateRequest</span> </td> - <td> <span class="datatype-description">Tag association request for a list of entities</span> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Condition.html"> + <td> <span class="datatype-name">Condition</span> +</td> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_EntityMutationResponse.html"> <td> <span class="datatype-name">EntityMutationResponse</span> </td> - <td> <span class="datatype-description">Entity modification response. Contains entity headers for each successful modification (create/update/delete)</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_EntityOperation.html"> <td> <span class="datatype-name">EntityOperation</span> </td> - <td> <span class="datatype-description">Entity operations supported by Atlas via REST</span> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_FilterCriteria.html"> + <td> <span class="datatype-name">FilterCriteria</span> +</td> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_LineageDirection.html"> <td> <span class="datatype-name">LineageDirection</span> </td> - <td> <span class="datatype-description">Lineage direction</span> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_LineageRelation.html"> <td> <span class="datatype-name">LineageRelation</span> </td> - <td> <span class="datatype-description">Lineage relation between two entities</span> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Operator.html"> + <td> <span class="datatype-name">Operator</span> +</td> + <td> <span class="datatype-description">Supported search operations +Logical comparision operators can only be used with numbers or dates +IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span> </td> </tr> <tr class="clickable-row" data-href="json_PList.html"> @@ -254,22 +325,109 @@ <td> <span class="datatype-description">Paginated-list, for returning search results.</span> </td> </tr> + <tr class="clickable-row" data-href="json_PropagateTags.html"> + <td> <span class="datatype-name">PropagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +Tags can propagate: +NONE - not at all +ONE_TO_TWO - from end 1 to 2 +TWO_TO_ONE - from end 2 to 1 +BOTH - both ways + +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: + +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here +- propagating classifications around Glossary synonyms - BOTH could be used here. + +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_RelationshipCategory.html"> + <td> <span class="datatype-name">RelationshipCategory</span> +</td> + <td> <span class="datatype-description">The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +ASSOCIATION is a relationship with no containment. +COMPOSITION and AGGREGATION are containment relationships. +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independant.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SearchParameters.html"> + <td> <span class="datatype-name">SearchParameters</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> <tr class="clickable-row" data-href="json_SortType.html"> <td> <span class="datatype-name">SortType</span> </td> - <td> <span class="datatype-description">Type of sorting to be applied on the result set, defaults to NONE</span> + <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> </td> </tr> <tr class="clickable-row" data-href="json_Status.html"> <td> <span class="datatype-name">Status</span> </td> - <td> <span class="datatype-description">Status of the entity - can be active or deleted.</span> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="json_TypeCategory.html"> <td> <span class="datatype-name">TypeCategory</span> </td> - <td> <span class="datatype-description">Category of a defined type</span> + <td> <span class="datatype-description"></span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_xml">XML</h3> + + <table class="table table-hover data-types"> + <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="xml_ns0_PList.html"> + <td> <span class="datatype-name">PList</span> +</td> + <td> <span class="datatype-description">Paginated-list, for returning search results.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_searchFilter.html"> + <td> <span class="datatype-name">searchFilter</span> +</td> + <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_sortType.html"> + <td> <span class="datatype-name">sortType</span> +</td> + <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html"> + <td> <span class="datatype-name">atlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> + <td> <span class="datatype-name">atlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> </td> </tr> </tbody>
