+ +

EntityResource

+ +

Entity management operations as REST API. + +An entity is an "instance" of a Type. Entities conform to the definition +of the Type they correspond with.

The following resources are applicable:

+ /entities +
+ /entities/{guid} +
+ /entities/{guid}/traits +
+ /entities/{guid}/traits/{traitName} +

+ +

/entities

+ +

POST

+ Submits an entity definition (instance) corresponding to a given type. +

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

GET

+ Gets the list of entities for a given entity type. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
type	+ name of a type which is unique +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/entities/{guid}

+ +

GET

+ Fetch the complete definition of an entity given its GUID. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
guid	+ GUID for the entity +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

PUT

+ Adds property to the given entity id +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +

name	description	type
guid	+ entity id +	path
property	+ property to add +	query
value	+ property's value +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

response payload as json

+ +

/entities/{guid}/traits

+ +

GET

+ Gets the list of trait names for a given entity represented by a guid. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
guid	+ globally unique identifier for the entity +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

a list of trait names for the given entity guid

+ +

POST

+ Adds a new trait to an existing entity represented by a guid. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
guid	+ globally unique identifier for the entity +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/entities/{guid}/traits/{traitName}

+ +

DELETE

+ Deletes a given trait from an existing entity represented by a guid. +

Parameters

+ + + + + + + + + + + + + + + + + + + +

name	description	type	default
guid	+ globally unique identifier for the entity +	path
traitName	+ name of the trait +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

+ + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/resource_HiveLineageResource.html ---------------------------------------------------------------------- diff --git a/api/resource_HiveLineageResource.html b/api/resource_HiveLineageResource.html new file mode 100644 index 0000000..d51204b --- /dev/null +++ b/api/resource_HiveLineageResource.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + HiveLineageResource + + + + + + + + + + + + + + + +

+ +

HiveLineageResource

+ +

Jersey Resource for Hive Table Lineage.

The following resources are applicable:

+ /lineage/hive/table/{tableName}/inputs/graph +
+ /lineage/hive/table/{tableName}/outputs/graph +
+ /lineage/hive/table/{tableName}/schema +

+ +

/lineage/hive/table/{tableName}/inputs/graph

+ +

GET

+ Returns the inputs graph for a given entity. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
tableName	+ table name +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/lineage/hive/table/{tableName}/outputs/graph

+ +

GET

+ Returns the outputs graph for a given entity. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
tableName	+ table name +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/lineage/hive/table/{tableName}/schema

+ +

GET

+ Return the schema for the given tableName. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
tableName	+ table name +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

+ + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/resource_MetadataDiscoveryResource.html ---------------------------------------------------------------------- diff --git a/api/resource_MetadataDiscoveryResource.html b/api/resource_MetadataDiscoveryResource.html new file mode 100644 index 0000000..c10cfc9 --- /dev/null +++ b/api/resource_MetadataDiscoveryResource.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + MetadataDiscoveryResource + + + + + + + + + + + + + + + +

+ +

MetadataDiscoveryResource

+ +

Jersey Resource for metadata operations.

The following resources are applicable:

+ /discovery/search +
+ /discovery/search/dsl +
+ /discovery/search/fulltext +
+ /discovery/search/gremlin +

+ +

/discovery/search

+ +

GET

+ Search using a given query. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
query	+ search query in raw gremlin or DSL format falling back to full text. +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

JSON representing the type and results.

+ +

/discovery/search/dsl

+ +

GET

+ Search using query DSL format. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
query	+ search query in DSL format. +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

JSON representing the type and results.

+ +

/discovery/search/fulltext

+ +

GET

+ Search using full text search. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
query	+ search query. +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

JSON representing the type and results.

+ +

/discovery/search/gremlin

+ +

GET

+ Search using raw gremlin query format. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
query	+ search query in raw gremlin format. +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

JSON representing the type and results.

+ +

+ + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/resource_RexsterGraphResource.html ---------------------------------------------------------------------- diff --git a/api/resource_RexsterGraphResource.html b/api/resource_RexsterGraphResource.html new file mode 100644 index 0000000..0defd1d --- /dev/null +++ b/api/resource_RexsterGraphResource.html @@ -0,0 +1,353 @@ + + + + + + + + + + + + + RexsterGraphResource + + + + + + + + + + + + + + + +

+ +

RexsterGraphResource

+ +

Jersey Resource for lineage metadata operations. +Implements most of the GET operations of Rexster API with out the indexes. +https://github.com/tinkerpop/rexster/wiki/Basic-REST-API + +This is a subset of Rexster's REST API, designed to provide only read-only methods +for accessing the backend graph.

The following resources are applicable:

+ /graph/edges/{id} +
+ /graph/vertices +
+ /graph/vertices/{id} +
+ /graph/vertices/{id}/{direction} +
+ /graph/vertices/properties/{id} +

+ +

/graph/edges/{id}

+ +

GET

+ Get a single edge with a unique id. + +GET http://host/metadata/lineage/edges/id +graph.getEdge(id); +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
id	+ (no documentation provided) +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/graph/vertices

+ +

GET

+ Get a list of vertices matching a property key and a value. +

+GET http://host/metadata/lineage/vertices?key=&value= +graph.getVertices(key, value); +

Parameters

+ + + + + + + + + + + + + + + + + + + +

name	description	type	default
key	+ (no documentation provided) +	query
value	+ (no documentation provided) +	query

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/graph/vertices/{id}

+ +

GET

+ Get a single vertex with a unique id. + +GET http://host/metadata/lineage/vertices/id +graph.getVertex(id); +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
id	+ (no documentation provided) +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/graph/vertices/{id}/{direction}

+ +

GET

+ Get a list of adjacent edges with a direction. + +GET http://host/metadata/lineage/vertices/id/direction +graph.getVertex(id).get{Direction}Edges(); +direction: {(?!outE)(?!bothE)(?!inE)(?!out)(?!both)(?!in)(?!query).+} +

Parameters

+ + + + + + + + + + + + + + + + + + + +

name	description	type	default
id	+ (no documentation provided) +	path
direction	+ (no documentation provided) +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

/graph/vertices/properties/{id}

+ +

GET

+ Get properties for a single vertex with a unique id. +This is NOT a rexster API. +

+GET http://host/metadata/lineage/vertices/properties/id +

Parameters

+ + + + + + + + + + + + + + + + + + + +

name	description	type	default
id	+ (no documentation provided) +	path
relationships	+ (no documentation provided) +	query	false

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

+ + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/resource_TypesResource.html ---------------------------------------------------------------------- diff --git a/api/resource_TypesResource.html b/api/resource_TypesResource.html new file mode 100644 index 0000000..0a8861b --- /dev/null +++ b/api/resource_TypesResource.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + TypesResource + + + + + + + + + + + + + + + +

+ +

TypesResource

+ +

This class provides RESTful API for Types. + +A type is the description of any representable item; +e.g. a Hive table + +You could represent any meta model representing any domain using these types.

The following resources are applicable:

+ /types +
+ /types/{typeName} +

+ +

/types

+ +

POST

+ Submits a type definition corresponding to a given type representing a meta model of a +domain. Could represent things like Hive Database, Hive Table, etc. +

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

GET

+ Gets the list of trait type names registered in the type system. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
type	+ type should be the name of enum +org.apache.atlas.typesystem.types.DataTypes.TypeCategory +Typically, would be one of all, TRAIT, CLASS, ENUM, STRUCT +	query	all

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

entity names response payload as json

+ +

/types/{typeName}

+ +

GET

+ Fetch the complete definition of a given type name which is unique. +

Parameters

+ + + + + + + + + + + + + +

name	description	type	default
typeName	+ name of a type which is unique. +	path

Response Body

+ + + + + + + + + +

element:	(custom)
media types:	application/json

(no documentation provided)

+ +

+ + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/rest.html ---------------------------------------------------------------------- diff --git a/api/rest.html b/api/rest.html new file mode 100644 index 0000000..447d099 --- /dev/null +++ b/api/rest.html @@ -0,0 +1,112 @@ + + + + + + + + + + + + + REST + + + + + + + + + + + + + + + +

+ +

REST Resources

+ This API supports a Representational State Transfer (REST) + model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model: +

+ There is also a WADL document describing the REST API. +

+ +

+ + + + + + + + + + + + + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/robots.txt ---------------------------------------------------------------------- diff --git a/api/robots.txt b/api/robots.txt new file mode 100644 index 0000000..d310d07 --- /dev/null +++ b/api/robots.txt @@ -0,0 +1,5 @@ +# www.robotstxt.org/ +# www.google.com/support/webmasters/bin/answer.py?hl=en&answer=156449 + +User-agent: * + http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/architecture.png ---------------------------------------------------------------------- diff --git a/architecture.png b/architecture.png new file mode 100644 index 0000000..826df37 Binary files /dev/null and b/architecture.png differ