Commit 4139050e by Dan Markwat

Added comments based on the team's discussions of the Type and

Repository systems
parent 34941a4f
...@@ -47,6 +47,9 @@ import java.io.StringWriter; ...@@ -47,6 +47,9 @@ import java.io.StringWriter;
/** /**
* Entity management operations as REST API. * 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.
*/ */
@Path("entities") @Path("entities")
public class EntityResource { public class EntityResource {
......
...@@ -22,6 +22,12 @@ import javax.ws.rs.Path; ...@@ -22,6 +22,12 @@ import javax.ws.rs.Path;
/** /**
* Jersey Resource for metadata operations. * Jersey Resource for metadata operations.
*
* The entry point for all operations against various aspects of the entities graph.
*
* For instance,
* lineage: given an entity, X, get me the lineage - all entities X is derived from (recursively)
* 'search': find entities generated by Hive processes or that were generated by Sqoop, etc.
*/ */
@Path("discovery") @Path("discovery")
public class MetadataDiscoveryResource { public class MetadataDiscoveryResource {
......
...@@ -54,6 +54,9 @@ import java.util.Set; ...@@ -54,6 +54,9 @@ import java.util.Set;
* Jersey Resource for lineage metadata operations. * Jersey Resource for lineage metadata operations.
* Implements most of the GET operations of Rexster API with out the indexes. * Implements most of the GET operations of Rexster API with out the indexes.
* https://github.com/tinkerpop/rexster/wiki/Basic-REST-API * 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.
*/ */
@Path("graph") @Path("graph")
public class RexsterGraphResource { public class RexsterGraphResource {
......
...@@ -26,6 +26,9 @@ import javax.ws.rs.core.Response; ...@@ -26,6 +26,9 @@ import javax.ws.rs.core.Response;
/** /**
* This class provides RESTful API for Types. * This class provides RESTful API for Types.
*
* A type is the description of any representable item;
* e.g. a Hive table
*/ */
@Path("types") @Path("types")
public class TypesResource { public class TypesResource {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment