http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4cccce5a/api/resource_EntityResource.html ---------------------------------------------------------------------- diff --git a/api/resource_EntityResource.html b/api/resource_EntityResource.html new file mode 100644 index 0000000..eb9b748 --- /dev/null +++ b/api/resource_EntityResource.html @@ -0,0 +1,381 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>EntityResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">EntityResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_EntityResource.html">EntityResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_HiveLineageResource.html">HiveLineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_RexsterGraphResource.html">RexsterGraphResource</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>EntityResource</h1> + + <p>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.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__entities.html">/entities</a> + </li> + <li> + <a href="#path__entities_-guid-.html">/entities/{guid}</a> + </li> + <li> + <a href="#path__entities_-guid-_traits.html">/entities/{guid}/traits</a> + </li> + <li> + <a href="#path__entities_-guid-_traits_-traitName-.html">/entities/{guid}/traits/{traitName}</a> + </li> + </ul> + <a name="path__entities.html"></a> + <h1>/entities</h1> + <a name="POST"></a> + <h2>POST</h2> + <p> + Submits an entity definition (instance) corresponding to a given type. + </p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="GET"></a> + <h2>GET</h2> + <p> + Gets the list of entities for a given entity type. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>type</td> + <td> + name of a type which is unique + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-.html"></a> + <h1>/entities/{guid}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetch the complete definition of an entity given its GUID. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + GUID for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="PUT"></a> + <h2>PUT</h2> + <p> + Adds property to the given entity id + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + entity id + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>property</td> + <td> + property to add + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>value</td> + <td> + property's value + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>response payload as json</p> + <a name="path__entities_-guid-_traits.html"></a> + <h1>/entities/{guid}/traits</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Gets the list of trait names for a given entity represented by a guid. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>a list of trait names for the given entity guid</p> + <a name="POST"></a> + <h2>POST</h2> + <p> + Adds a new trait to an existing entity represented by a guid. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-_traits_-traitName-.html"></a> + <h1>/entities/{guid}/traits/{traitName}</h1> + <a name="DELETE"></a> + <h2>DELETE</h2> + <p> + Deletes a given trait from an existing entity represented by a guid. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>traitName</td> + <td> + name of the trait + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html>
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 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>HiveLineageResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">HiveLineageResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_HiveLineageResource.html">HiveLineageResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_HiveLineageResource.html">HiveLineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_RexsterGraphResource.html">RexsterGraphResource</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>HiveLineageResource</h1> + + <p>Jersey Resource for Hive Table Lineage.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__lineage_hive_table_-tableName-_inputs_graph.html">/lineage/hive/table/{tableName}/inputs/graph</a> + </li> + <li> + <a href="#path__lineage_hive_table_-tableName-_outputs_graph.html">/lineage/hive/table/{tableName}/outputs/graph</a> + </li> + <li> + <a href="#path__lineage_hive_table_-tableName-_schema.html">/lineage/hive/table/{tableName}/schema</a> + </li> + </ul> + <a name="path__lineage_hive_table_-tableName-_inputs_graph.html"></a> + <h1>/lineage/hive/table/{tableName}/inputs/graph</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the inputs graph for a given entity. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>tableName</td> + <td> + table name + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__lineage_hive_table_-tableName-_outputs_graph.html"></a> + <h1>/lineage/hive/table/{tableName}/outputs/graph</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the outputs graph for a given entity. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>tableName</td> + <td> + table name + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__lineage_hive_table_-tableName-_schema.html"></a> + <h1>/lineage/hive/table/{tableName}/schema</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Return the schema for the given tableName. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>tableName</td> + <td> + table name + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> 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 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>MetadataDiscoveryResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">MetadataDiscoveryResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_HiveLineageResource.html">HiveLineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_RexsterGraphResource.html">RexsterGraphResource</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>MetadataDiscoveryResource</h1> + + <p>Jersey Resource for metadata operations.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__discovery_search.html">/discovery/search</a> + </li> + <li> + <a href="#path__discovery_search_dsl.html">/discovery/search/dsl</a> + </li> + <li> + <a href="#path__discovery_search_fulltext.html">/discovery/search/fulltext</a> + </li> + <li> + <a href="#path__discovery_search_gremlin.html">/discovery/search/gremlin</a> + </li> + </ul> + <a name="path__discovery_search.html"></a> + <h1>/discovery/search</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using a given query. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query in raw gremlin or DSL format falling back to full text. + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + <a name="path__discovery_search_dsl.html"></a> + <h1>/discovery/search/dsl</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using query DSL format. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query in DSL format. + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + <a name="path__discovery_search_fulltext.html"></a> + <h1>/discovery/search/fulltext</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using full text search. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query. + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + <a name="path__discovery_search_gremlin.html"></a> + <h1>/discovery/search/gremlin</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using raw gremlin query format. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query in raw gremlin format. + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> 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 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>RexsterGraphResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">RexsterGraphResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_RexsterGraphResource.html">RexsterGraphResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_HiveLineageResource.html">HiveLineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_RexsterGraphResource.html">RexsterGraphResource</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>RexsterGraphResource</h1> + + <p>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.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__graph_edges_-id-.html">/graph/edges/{id}</a> + </li> + <li> + <a href="#path__graph_vertices.html">/graph/vertices</a> + </li> + <li> + <a href="#path__graph_vertices_-id-.html">/graph/vertices/{id}</a> + </li> + <li> + <a href="#path__graph_vertices_-id-_-direction-.html">/graph/vertices/{id}/{direction}</a> + </li> + <li> + <a href="#path__graph_vertices_properties_-id-.html">/graph/vertices/properties/{id}</a> + </li> + </ul> + <a name="path__graph_edges_-id-.html"></a> + <h1>/graph/edges/{id}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Get a single edge with a unique id. + +GET http://host/metadata/lineage/edges/id +graph.getEdge(id); + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>id</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__graph_vertices.html"></a> + <h1>/graph/vertices</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Get a list of vertices matching a property key and a value. +<p/> +GET http://host/metadata/lineage/vertices?key=<key>&value=<value> +graph.getVertices(key, value); + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>key</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>value</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__graph_vertices_-id-.html"></a> + <h1>/graph/vertices/{id}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Get a single vertex with a unique id. + +GET http://host/metadata/lineage/vertices/id +graph.getVertex(id); + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>id</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__graph_vertices_-id-_-direction-.html"></a> + <h1>/graph/vertices/{id}/{direction}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + 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).+} + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>id</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>direction</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__graph_vertices_properties_-id-.html"></a> + <h1>/graph/vertices/properties/{id}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Get properties for a single vertex with a unique id. +This is NOT a rexster API. +<p/> +GET http://host/metadata/lineage/vertices/properties/id + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>id</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>relationships</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td>false</td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> 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 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>TypesResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">TypesResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_TypesResource.html">TypesResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_HiveLineageResource.html">HiveLineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_RexsterGraphResource.html">RexsterGraphResource</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>TypesResource</h1> + + <p>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.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__types.html">/types</a> + </li> + <li> + <a href="#path__types_-typeName-.html">/types/{typeName}</a> + </li> + </ul> + <a name="path__types.html"></a> + <h1>/types</h1> + <a name="POST"></a> + <h2>POST</h2> + <p> + 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. + </p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="GET"></a> + <h2>GET</h2> + <p> + Gets the list of trait type names registered in the type system. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>type</td> + <td> + type should be the name of enum +org.apache.atlas.typesystem.types.DataTypes.TypeCategory +Typically, would be one of all, TRAIT, CLASS, ENUM, STRUCT + </td> + <td>query</td> + <td>all</td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>entity names response payload as json</p> + <a name="path__types_-typeName-.html"></a> + <h1>/types/{typeName}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetch the complete definition of a given type name which is unique. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>typeName</td> + <td> + name of a type which is unique. + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> 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 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>REST</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">REST</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li class="current"> + <a href="rest.html">REST</a> + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>REST Resources</h1> + <p> + This API supports a <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer";>Representational State Transfer (REST)</a> + model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model: + </p> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_HiveLineageResource.html">HiveLineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_RexsterGraphResource.html">RexsterGraphResource</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + <p> + There is also a <a href="application.wadl">WADL document</a> describing the REST API. + </p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> 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
