Repository: incubator-atlas-website Updated Branches: refs/heads/asf-site a4141169b -> 4164eb065
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/xml_ns0_PList.html ---------------------------------------------------------------------- diff --git a/api/v2/xml_ns0_PList.html b/api/v2/xml_ns0_PList.html new file mode 100644 index 0000000..0819f11 --- /dev/null +++ b/api/v2/xml_ns0_PList.html @@ -0,0 +1,242 @@ +<!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: PList</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: PList</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 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="active dropdown"><a href="syntax_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_PList.html">PList</a></li> + </ol> + + <h1 class="page-header">PList <small>Data Type</small></h1> + + <p>Paginated-list, for returning search results.</p> + + <dl class="dl-horizontal"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">list</span> +</td> + <td> <span class="datatype-reference">anyType +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/unbounded +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">pageSize</span> +</td> + <td> <span class="datatype-reference">int +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortBy</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortType</span> +</td> + <td> <span class="datatype-reference"><a href="xml_ns0_sortType.html">sortType</a> +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">startIndex</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">totalCount</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-xml example"><PList> + <list>...</list> + <startIndex>...</startIndex> + <pageSize>...</pageSize> + <totalCount>...</totalCount> + <sortType>...</sortType> + <sortBy>...</sortBy> +</PList> +</pre> + + <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> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/xml_ns0_searchFilter.html ---------------------------------------------------------------------- diff --git a/api/v2/xml_ns0_searchFilter.html b/api/v2/xml_ns0_searchFilter.html new file mode 100644 index 0000000..fbe654c --- /dev/null +++ b/api/v2/xml_ns0_searchFilter.html @@ -0,0 +1,242 @@ +<!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: searchFilter</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: searchFilter</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 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="active dropdown"><a href="syntax_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_searchFilter.html">searchFilter</a></li> + </ol> + + <h1 class="page-header">searchFilter <small>Data Type</small></h1> + + <p>Generic filter, to specify search criteria using name/value pairs.</p> + + <dl class="dl-horizontal"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">getCount</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">maxRows</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">params</span> +</td> + <td> <span class="datatype-reference">(custom) +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortBy</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortType</span> +</td> + <td> <span class="datatype-reference"><a href="xml_ns0_sortType.html">sortType</a> +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">startIndex</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-xml example"><searchFilter> + <params>...</params> + <startIndex>...</startIndex> + <maxRows>...</maxRows> + <getCount>...</getCount> + <sortBy>...</sortBy> + <sortType>...</sortType> +</searchFilter> +</pre> + + <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> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/xml_ns0_sortType.html ---------------------------------------------------------------------- diff --git a/api/v2/xml_ns0_sortType.html b/api/v2/xml_ns0_sortType.html new file mode 100644 index 0000000..8d42fbb --- /dev/null +++ b/api/v2/xml_ns0_sortType.html @@ -0,0 +1,130 @@ +<!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: sortType</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: sortType</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 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="active dropdown"><a href="syntax_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_sortType.html">sortType</a></li> + </ol> + + <h1 class="page-header">sortType <small>Data Type</small></h1> + + <p>to specify whether the result should be sorted? If yes, whether asc or desc.</p> + + <dl class="dl-horizontal"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </dl> + + <table class="table datatype-values"> + <caption>Values</caption> + <thead> + <tr> + <th>value</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="value-value">NONE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">ASC</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">DESC</span></td> + <td><span class="value-description"></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> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index 2bd6ee9..3ed431d 100644 --- a/index.html +++ b/index.html @@ -276,7 +276,8 @@ <h3><a name="API_Documentation"></a>API Documentation</h3> <p></p> <ul> -<li><a href="api/rest.html">REST API Documentation</a></li></ul></div> +<li><a href="api/v2/index.html">REST API Documentation</a></li> +<li><a href="api/rest.html">Legacy API Documentation</a></li></ul></div> <div class="section"> <h3><a name="Developer_Setup_Documentation"></a>Developer Setup Documentation</h3> <p></p>
