http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_TaxonomyService.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_TaxonomyService.html b/1.1.0/api/resource_TaxonomyService.html new file mode 100644 index 0000000..78df42f --- /dev/null +++ b/1.1.0/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/atlas-website/blob/ab60d06f/1.1.0/api/resource_TypesResource.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_TypesResource.html b/1.1.0/api/resource_TypesResource.html new file mode 100644 index 0000000..b62c23b --- /dev/null +++ b/1.1.0/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/atlas-website/blob/ab60d06f/1.1.0/api/rest.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/rest.html b/1.1.0/api/rest.html new file mode 100644 index 0000000..6ceedf9 --- /dev/null +++ b/1.1.0/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/atlas-website/blob/ab60d06f/1.1.0/api/robots.txt ---------------------------------------------------------------------- diff --git a/1.1.0/api/robots.txt b/1.1.0/api/robots.txt new file mode 100644 index 0000000..d310d07 --- /dev/null +++ b/1.1.0/api/robots.txt @@ -0,0 +1,5 @@ +# www.robotstxt.org/ +# www.google.com/support/webmasters/bin/answer.py?hl=en&answer=156449 + +User-agent: * +