http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/0.8.0-incubating/api/resource_TaxonomyService.html ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/resource_TaxonomyService.html b/0.8.0-incubating/api/resource_TaxonomyService.html new file mode 100644 index 0000000..78df42f --- /dev/null +++ b/0.8.0-incubating/api/resource_TaxonomyService.html @@ -0,0 +1,758 @@ +<!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>TaxonomyService</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">TaxonomyService</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> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</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> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_TaxonomyService.html">TaxonomyService</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</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>TaxonomyService</h1> + + <p>Service which handles API requests for taxonomy and term resources.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__v1_taxonomies.html">/v1/taxonomies</a> + </li> + <li> + <a href="#path__v1_taxonomies_-taxonomyName-.html">/v1/taxonomies/{taxonomyName}</a> + </li> + <li> + <a href="#path__v1_taxonomies_-taxonomyName-_terms.html">/v1/taxonomies/{taxonomyName}/terms</a> + </li> + <li> + <a href="#path__v1_taxonomies_-taxonomyName-_terms_-rootTerm-_-remainder-.html">/v1/taxonomies/{taxonomyName}/terms/{rootTerm}/{remainder}</a> + </li> + <li> + <a href="#path__v1_taxonomies_-taxonomyName-_terms_-termName-.html">/v1/taxonomies/{taxonomyName}/terms/{termName}</a> + </li> + <li> + <a href="#path__v1_taxonomies_-taxonomyName-_terms_-termName-_-remainder-.html">/v1/taxonomies/{taxonomyName}/terms/{termName}/{remainder}</a> + </li> + </ul> + <a name="path__v1_taxonomies.html"></a> + <h1>/v1/taxonomies</h1> + <a name="GET"></a> + <h2>GET</h2> + <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__v1_taxonomies_-taxonomyName-.html"></a> + <h1>/v1/taxonomies/{taxonomyName}</h1> + <p> + The following operations are supported on this resource: + </p> + <ul> + <li><a href="#GET">GET</a></li> + <li><a href="#POST">POST</a></li> + <li><a href="#PUT">PUT</a></li> + <li><a href="#DELETE">DELETE</a></li> + </ul> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</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="POST"></a> + <h2>POST</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</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="PUT"></a> + <h2>PUT</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</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="DELETE"></a> + <h2>DELETE</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</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__v1_taxonomies_-taxonomyName-_terms.html"></a> + <h1>/v1/taxonomies/{taxonomyName}/terms</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</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__v1_taxonomies_-taxonomyName-_terms_-rootTerm-_-remainder-.html"></a> + <h1>/v1/taxonomies/{taxonomyName}/terms/{rootTerm}/{remainder}</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>rootTerm</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>remainder</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__v1_taxonomies_-taxonomyName-_terms_-termName-.html"></a> + <h1>/v1/taxonomies/{taxonomyName}/terms/{termName}</h1> + <p> + The following operations are supported on this resource: + </p> + <ul> + <li><a href="#GET">GET</a></li> + <li><a href="#POST">POST</a></li> + <li><a href="#PUT">PUT</a></li> + <li><a href="#DELETE">DELETE</a></li> + </ul> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</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="POST"></a> + <h2>POST</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</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="PUT"></a> + <h2>PUT</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</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="DELETE"></a> + <h2>DELETE</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</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__v1_taxonomies_-taxonomyName-_terms_-termName-_-remainder-.html"></a> + <h1>/v1/taxonomies/{taxonomyName}/terms/{termName}/{remainder}</h1> + <p> + The following operations are supported on this resource: + </p> + <ul> + <li><a href="#POST">POST</a></li> + <li><a href="#PUT">PUT</a></li> + <li><a href="#DELETE">DELETE</a></li> + </ul> + <a name="POST"></a> + <h2>POST</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>remainder</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</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="PUT"></a> + <h2>PUT</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>remainder</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</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="DELETE"></a> + <h2>DELETE</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>taxonomyName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>termName</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>remainder</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> + + <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/b4557f9c/0.8.0-incubating/api/resource_TypesResource.html ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/resource_TypesResource.html b/0.8.0-incubating/api/resource_TypesResource.html new file mode 100644 index 0000000..b62c23b --- /dev/null +++ b/0.8.0-incubating/api/resource_TypesResource.html @@ -0,0 +1,267 @@ +<!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> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</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> + <li><a href="downloads.html">Files and Libraries</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_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</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> + <p> + The following operations are supported on this resource: + </p> + <ul> + <li><a href="#POST">POST</a></li> + <li><a href="#PUT">PUT</a></li> + <li><a href="#GET">GET</a></li> + </ul> + <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="PUT"></a> + <h2>PUT</h2> + <p> + Update of existing types - if the given type doesn't exist, creates new type +Allowed updates are: +1. Add optional attribute +2. Change required to optional attribute +3. Add super types - super types shouldn't contain any required attributes + </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> + Return the list of type names in the type system which match the specified filter. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>type</td> + <td> + returns types whose category is the given typeCategory + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>supertype</td> + <td> + returns types which contain the given supertype + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>notsupertype</td> + <td> + returns types which do not contain the given supertype + +Its possible to specify combination of these filters in one request and the conditions are combined with AND +For example, typeCategory = TRAIT && supertype contains 'X' && supertype !contains 'Y' +If there is no filter, all the types are returned + </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>list of type names</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/b4557f9c/0.8.0-incubating/api/rest.html ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/rest.html b/0.8.0-incubating/api/rest.html new file mode 100644 index 0000000..6ceedf9 --- /dev/null +++ b/0.8.0-incubating/api/rest.html @@ -0,0 +1,120 @@ +<!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> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</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> + <li><a href="downloads.html">Files and Libraries</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_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + <p> + The REST resources expose a data model that is supported by a set of client-side libraries that are made available on the + <a href="downloads.html">files and libraries</a> page. + </p> + <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/b4557f9c/0.8.0-incubating/api/robots.txt ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/robots.txt b/0.8.0-incubating/api/robots.txt new file mode 100644 index 0000000..d310d07 --- /dev/null +++ b/0.8.0-incubating/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/b4557f9c/0.8.0-incubating/api/v2/application.wadl ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/v2/application.wadl b/0.8.0-incubating/api/v2/application.wadl new file mode 100644 index 0000000..35a0d1c --- /dev/null +++ b/0.8.0-incubating/api/v2/application.wadl @@ -0,0 +1,602 @@ +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<?enunciate-assumed-base-uri ./?> +<wadl:application xmlns:wadl="http://wadl.dev.java.net/2009/02"; xmlns:xs="http://www.w3.org/2001/XMLSchema";> + + <wadl:doc xmlns:enunciate="http://enunciate.webcohesion.com/"; enunciate:generatedBy="Enunciate-2.0"/> + + <wadl:grammars> + </wadl:grammars> + + <wadl:resources base="./"> + + <wadl:resource path="v2/entity"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create new entity or update existing entity in Atlas. +Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> + <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> + <wadl:request> + <wadl:param name="guid" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/entity/bulk"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Bulk API to create new entities or update existing entities in Atlas. +Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName]]></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="DELETE"> + <wadl:doc><![CDATA[Bulk API to delete list of entities identified by its GUIDs]]></wadl:doc> + <wadl:request> + <wadl:param name="guid" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/lineage/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Returns lineage info about entity.]]></wadl:doc> + <wadl:request> + <wadl:param name="depth" style="query"> + <wadl:doc><![CDATA[- number of hops for lineage]]></wadl:doc> + </wadl:param> + <wadl:param name="direction" style="query"> + <wadl:doc><![CDATA[- input, output or both]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[Bad query parameters]]></wadl:doc> + </wadl:response> + <wadl:response status="404"> + <wadl:doc><![CDATA[If no lineage is found for the given entity]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[AtlasLineageInfo]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[- unique entity id]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/search/basic"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc> + <wadl:request> + <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="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="query" style="query"> + <wadl:doc><![CDATA[Fulltext query]]></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 fulltext 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/dsl"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Retrieve data for the specified DSL]]></wadl:doc> + <wadl:request> + <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="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="query" style="query"> + <wadl:doc><![CDATA[DSL query]]></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 DSL 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/fulltext"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc> + <wadl:request> + <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="query" style="query"> + <wadl:doc><![CDATA[Fulltext query]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[Invalid fulltext 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/types/typedefs"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Bulk retrieval API for retrieving all type definitions in Atlas]]></wadl:doc> + <wadl:response status="200"> + <wadl:doc><![CDATA[A composite wrapper object with lists of all type definitions]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/types/typedefs"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Bulk create APIs for all atlas type definitions, only new definitions will be created. +Any changes to the existing definitions will be discarded]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[A composite wrapper object with corresponding lists of the type definition]]></wadl:doc> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[A composite wrapper object with lists of type definitions that were successfully +created]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/types/typedefs"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Bulk update API for all types, changes detected in the type definitions would be persisted]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[A composite object that captures all type definition changes]]></wadl:doc> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[A composite object with lists of type definitions that were updated]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/types/typedefs"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Bulk delete API for all types]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[A composite object that captures all types to be deleted]]></wadl:doc> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/entity/bulk/classification"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Bulk API to associate a tag to multiple entities]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + </wadl:request> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Fetch complete definition of an entity given its GUID.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[AtlasEntity]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[GUID for the entity]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Entity Partial Update - Add/Update entity attribute identified by its GUID. +Supports only uprimitive attribute type and entity references. +does not support updation of complex types like arrays, maps +Null updates are not possible]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + <wadl:param name="name" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </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/entity/guid/{guid}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete an entity identified by its GUID.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[GUID for the entity]]></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> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of AtlasTypeDefHeader AtlasTypeDefHeader]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}/classifications"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Gets the list of classifications for a given entity represented by a guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[a list of classifications for the given entity guid]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </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/guid/{guid}/classifications"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Adds classifications to an existing entity represented by a guid.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </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> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[AtlasEntityWithExtInfo]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Entity Partial Update - Allows a subset of attributes to be updated on +an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. +Null updates are not possible]]></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:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete an entity identified by its type and unique attributes.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[- entity type to be deleted]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/classificationdef/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the classification 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[classification definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[classification guid]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/classificationdef/name/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the classification 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[classification definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[classification name]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/entitydef/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the Entity 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[Entity definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[entity guid]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/entitydef/name/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the entity 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[Entity definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[entity name]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/enumdef/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the enum 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[enum definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[enum guid]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/enumdef/name/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the enum 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[enum definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[enum 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> + <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[struct definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[struct guid]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/structdef/name/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the struct 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[struct definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[struct name]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/typedef/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[Failed lookup]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Type definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[GUID of the type]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/typedef/name/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get type definition by it's name]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[Failed lookup by name]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Type definition]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[Type name]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}/classification/{classificationName}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Gets the list of classifications for a given entity represented by a guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[classification for the given entity guid]]></wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:param name="classificationName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + <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/guid/{guid}/classification/{classificationName}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Deletes a given classification from an existing entity represented by a guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + </wadl:method> + <wadl:param name="classificationName" style="template"> + <wadl:doc><![CDATA[name of the classifcation]]></wadl:doc> + </wadl:param> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + </wadl:param> + </wadl:resource> + </wadl:resources> +</wadl:application> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/0.8.0-incubating/api/v2/css/style.css ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/v2/css/style.css b/0.8.0-incubating/api/v2/css/style.css new file mode 100644 index 0000000..8e05fb7 --- /dev/null +++ b/0.8.0-incubating/api/v2/css/style.css @@ -0,0 +1,115 @@ +/* + * Base structure + */ + +/* Move down content because we have a fixed navbar that is 50px tall */ +body { + position:relative; + padding-top: 50px; +} + +.footer { + width: 100%; + /* Set the fixed height of the footer here */ + height: 60px; + background-color: #f5f5f5; +} + +/* + * Global add-ons + */ +.sub-header { + padding-bottom: 10px; + border-bottom: 1px solid #eee; +} + +/* + * Sidebar + */ + +/* Hide for mobile, show later */ +.sidebar { + display: none; +} +@media (min-width: 768px) { + .sidebar { + position: fixed; + top: 51px; + bottom: 0; + left: 0; + z-index: 1000; + display: block; + padding: 20px; + overflow-x: hidden; + overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */ + background-color: #f5f5f5; + border-right: 1px solid #eee; + } +} + +/* Sidebar navigation */ +.nav-sidebar { + margin-right: -21px; /* 20px padding + 1px border */ + margin-bottom: 20px; + margin-left: -20px; +} +.nav-sidebar > li > a { + padding-right: 20px; + padding-left: 20px; +} +.nav-sidebar > .active > a, +.nav-sidebar > .active > a:hover, +.nav-sidebar > .active > a:focus { + color: #fff; + background-color: #428bca; +} + +/* + * Main content + */ +.main { + padding: 20px; +} +@media (min-width: 768px) { + .main { + padding-right: 40px; + padding-left: 40px; + } +} +.main .page-header { + margin-top: 0; +} +.footer > .container { + padding-top: 20px; + text-align: center; +} + +/* + * Row Links + */ +.table.rowlink td:not(.rowlink-skip), +.table .rowlink td:not(.rowlink-skip) { + cursor: pointer; +} +.table.rowlink td:not(.rowlink-skip) a, +.table .rowlink td:not(.rowlink-skip) a { + font: inherit; + color: inherit; + text-decoration: inherit; +} +.multi-row-description { + border-left: 1px solid #DDD; +} + +pre { + max-height: 40em; +} + +/* shift the anchors to accommodate fixed navbar. See https://github.com/twbs/bootstrap/issues/1768#issuecomment-46519033 */ +*[id]:before { + display: block; + content: " "; + margin-top: -70px; + height: 70px; + visibility: hidden; +} http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/0.8.0-incubating/api/v2/data.html ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/v2/data.html b/0.8.0-incubating/api/v2/data.html new file mode 100644 index 0000000..c61a827 --- /dev/null +++ b/0.8.0-incubating/api/v2/data.html @@ -0,0 +1,309 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: Data Types</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/style.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: Data Types</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <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 class="divider"></li> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="dropdown"><a href="data.html">Data Types</a></li> + </ol> + + <h1 class="page-header" id="data">Data Types</h1> + + <h3 id="syntax_json">JSON</h3> + + <table class="table table-hover data-types"> + <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="json_AtlasAttributeDef.html"> + <td> <span class="datatype-name">AtlasAttributeDef</span> +</td> + <td> <span class="datatype-description">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> + </tr> + <tr class="clickable-row" data-href="json_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="json_AtlasClassificationDef.html"> + <td> <span class="datatype-name">AtlasClassificationDef</span> +</td> + <td> <span class="datatype-description">Details of a classification-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasClassifications.html"> + <td> <span class="datatype-name">AtlasClassifications</span> +</td> + <td> <span class="datatype-description">REST serialization friendly list.</span> +</td> + </tr> + <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> + </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> + </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> + </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> + </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> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </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> + </tr> + <tr class="clickable-row" data-href="json_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="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> + </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> + </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> + </tr> + </tbody> + </table> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com";>Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js";></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"; type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html>
