http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_NumberFormat.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_NumberFormat.html b/1.1.0/api/v2/json_NumberFormat.html new file mode 100644 index 0000000..747b482 --- /dev/null +++ b/1.1.0/api/v2/json_NumberFormat.html @@ -0,0 +1,339 @@ +<!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: NumberFormat</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/enunciate.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: NumberFormat</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_json.html">JSON</a></li> + <li class="dropdown"><a href="json_NumberFormat.html">NumberFormat</a></li> + </ol> + + <h1 class="page-header">NumberFormat <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Abstract Type</dt> + <dd></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span id="prop-availableLocales" class="property-name">availableLocales</span> +</td> + <td> <span class="datatype-reference">array of string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-currency" class="property-name">currency</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-currencyInstance" class="property-name">currencyInstance</span> +</td> + <td> <span class="datatype-reference"><a href="json_NumberFormat.html">NumberFormat</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-groupingUsed" class="property-name">groupingUsed</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-instance" class="property-name">instance</span> +</td> + <td> <span class="datatype-reference"><a href="json_NumberFormat.html">NumberFormat</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-integerInstance" class="property-name">integerInstance</span> +</td> + <td> <span class="datatype-reference"><a href="json_NumberFormat.html">NumberFormat</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-maximumFractionDigits" class="property-name">maximumFractionDigits</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-maximumIntegerDigits" class="property-name">maximumIntegerDigits</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-minimumFractionDigits" class="property-name">minimumFractionDigits</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-minimumIntegerDigits" class="property-name">minimumIntegerDigits</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-numberInstance" class="property-name">numberInstance</span> +</td> + <td> <span class="datatype-reference"><a href="json_NumberFormat.html">NumberFormat</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-parseIntegerOnly" class="property-name">parseIntegerOnly</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-percentInstance" class="property-name">percentInstance</span> +</td> + <td> <span class="datatype-reference"><a href="json_NumberFormat.html">NumberFormat</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-roundingMode" class="property-name">roundingMode</span> +</td> + <td> <span class="datatype-reference"><a href="json_RoundingMode.html">RoundingMode</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div> + + <pre class="prettyprint language-js example">{ + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "UP" + }, + "groupingUsed" : true, + "instance" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "UP" + }, + "integerInstance" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "HALF_UP" + }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "FLOOR" + }, + "parseIntegerOnly" : true, + "percentInstance" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "HALF_EVEN" + }, + "roundingMode" : "DOWN" +}</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/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_Operator.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_Operator.html b/1.1.0/api/v2/json_Operator.html index 333b019..929069a 100644 --- a/1.1.0/api/v2/json_Operator.html +++ b/1.1.0/api/v2/json_Operator.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,22 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#LT"><abbr title="LT"><span class="sideoverflow">LT</span></abbr></a></li> + <li><a href="#GT"><abbr title="GT"><span class="sideoverflow">GT</span></abbr></a></li> + <li><a href="#LTE"><abbr title="LTE"><span class="sideoverflow">LTE</span></abbr></a></li> + <li><a href="#GTE"><abbr title="GTE"><span class="sideoverflow">GTE</span></abbr></a></li> + <li><a href="#EQ"><abbr title="EQ"><span class="sideoverflow">EQ</span></abbr></a></li> + <li><a href="#NEQ"><abbr title="NEQ"><span class="sideoverflow">NEQ</span></abbr></a></li> + <li><a href="#IN"><abbr title="IN"><span class="sideoverflow">IN</span></abbr></a></li> + <li><a href="#LIKE"><abbr title="LIKE"><span class="sideoverflow">LIKE</span></abbr></a></li> + <li><a href="#STARTS_WITH"><abbr title="STARTS_WITH"><span class="sideoverflow">STARTS_WITH</span></abbr></a></li> + <li><a href="#ENDS_WITH"><abbr title="ENDS_WITH"><span class="sideoverflow">ENDS_WITH</span></abbr></a></li> + <li><a href="#CONTAINS"><abbr title="CONTAINS"><span class="sideoverflow">CONTAINS</span></abbr></a></li> + <li><a href="#CONTAINS_ANY"><abbr title="CONTAINS_ANY"><span class="sideoverflow">CONTAINS_ANY</span></abbr></a></li> + <li><a href="#CONTAINS_ALL"><abbr title="CONTAINS_ALL"><span class="sideoverflow">CONTAINS_ALL</span></abbr></a></li> + <li><a href="#IS_NULL"><abbr title="IS_NULL"><span class="sideoverflow">IS_NULL</span></abbr></a></li> + <li><a href="#NOT_NULL"><abbr title="NOT_NULL"><span class="sideoverflow">NOT_NULL</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -80,47 +96,63 @@ IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</ </thead> <tbody> <tr> - <td><span class="value-value">LT</span></td> + <td><span class="value-value" id="LT">LT</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">GT</span></td> + <td><span class="value-value" id="GT">GT</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">LTE</span></td> + <td><span class="value-value" id="LTE">LTE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">GTE</span></td> + <td><span class="value-value" id="GTE">GTE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">EQ</span></td> + <td><span class="value-value" id="EQ">EQ</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">NEQ</span></td> + <td><span class="value-value" id="NEQ">NEQ</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">IN</span></td> + <td><span class="value-value" id="IN">IN</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">LIKE</span></td> + <td><span class="value-value" id="LIKE">LIKE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">STARTS_WITH</span></td> + <td><span class="value-value" id="STARTS_WITH">STARTS_WITH</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">ENDS_WITH</span></td> + <td><span class="value-value" id="ENDS_WITH">ENDS_WITH</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">CONTAINS</span></td> + <td><span class="value-value" id="CONTAINS">CONTAINS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="CONTAINS_ANY">CONTAINS_ANY</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="CONTAINS_ALL">CONTAINS_ALL</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="IS_NULL">IS_NULL</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="NOT_NULL">NOT_NULL</span></td> <td><span class="value-description"></span></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_PList.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_PList.html b/1.1.0/api/v2/json_PList.html index d30fdb9..6795bee 100644 --- a/1.1.0/api/v2/json_PList.html +++ b/1.1.0/api/v2/json_PList.html @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">list</span> + <td> <span id="prop-list" class="property-name">list</span> </td> <td> <span class="datatype-reference">array of object </span> @@ -88,7 +88,7 @@ </td> </tr> <tr> - <td> <span class="property-name">startIndex</span> + <td> <span id="prop-pageSize" class="property-name">pageSize</span> </td> <td> <span class="datatype-reference">number </span> @@ -97,36 +97,36 @@ </td> </tr> <tr> - <td> <span class="property-name">pageSize</span> + <td> <span id="prop-sortBy" class="property-name">sortBy</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">totalCount</span> + <td> <span id="prop-sortType" class="property-name">sortType</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">sortType</span> + <td> <span id="prop-startIndex" class="property-name">startIndex</span> </td> - <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">sortBy</span> + <td> <span id="prop-totalCount" class="property-name">totalCount</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> @@ -139,11 +139,11 @@ <pre class="prettyprint language-js example">{ "list" : [ { }, { } ], - "startIndex" : 12345, "pageSize" : 12345, - "totalCount" : 12345, - "sortType" : "NONE", - "sortBy" : "..." + "sortBy" : "...", + "sortType" : "ASC", + "startIndex" : 12345, + "totalCount" : 12345 }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_PropagateTags.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_PropagateTags.html b/1.1.0/api/v2/json_PropagateTags.html index 13bbc6c..809a68d 100644 --- a/1.1.0/api/v2/json_PropagateTags.html +++ b/1.1.0/api/v2/json_PropagateTags.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,11 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#NONE"><abbr title="NONE"><span class="sideoverflow">NONE</span></abbr></a></li> + <li><a href="#ONE_TO_TWO"><abbr title="ONE_TO_TWO"><span class="sideoverflow">ONE_TO_TWO</span></abbr></a></li> + <li><a href="#TWO_TO_ONE"><abbr title="TWO_TO_ONE"><span class="sideoverflow">TWO_TO_ONE</span></abbr></a></li> + <li><a href="#BOTH"><abbr title="BOTH"><span class="sideoverflow">BOTH</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -64,17 +69,19 @@ <h1 class="page-header">PropagateTags <small>Data Type</small></h1> <p>PropagateTags indicates whether tags should propagate across the relationship instance. +<p> Tags can propagate: -NONE - not at all -ONE_TO_TWO - from end 1 to 2 -TWO_TO_ONE - from end 2 to 1 +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> BOTH - both ways - +<p> Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: - -- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> - propagating classifications around Glossary synonyms - BOTH could be used here. - +<p> There is an expectation that further enhancements will allow more granular control of tag propagation and will address how to resolve conflicts.</p> @@ -91,19 +98,19 @@ address how to resolve conflicts.</p> </thead> <tbody> <tr> - <td><span class="value-value">NONE</span></td> + <td><span class="value-value" id="NONE">NONE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">ONE_TO_TWO</span></td> + <td><span class="value-value" id="ONE_TO_TWO">ONE_TO_TWO</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">TWO_TO_ONE</span></td> + <td><span class="value-value" id="TWO_TO_ONE">TWO_TO_ONE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">BOTH</span></td> + <td><span class="value-value" id="BOTH">BOTH</span></td> <td><span class="value-description"></span></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_Relation.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_Relation.html b/1.1.0/api/v2/json_Relation.html new file mode 100644 index 0000000..9516446 --- /dev/null +++ b/1.1.0/api/v2/json_Relation.html @@ -0,0 +1,180 @@ +<!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: Relation</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/enunciate.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: Relation</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="#SEE_ALSO"><abbr title="SEE_ALSO"><span class="sideoverflow">SEE_ALSO</span></abbr></a></li> + <li><a href="#SYNONYMS"><abbr title="SYNONYMS"><span class="sideoverflow">SYNONYMS</span></abbr></a></li> + <li><a href="#ANTONYMS"><abbr title="ANTONYMS"><span class="sideoverflow">ANTONYMS</span></abbr></a></li> + <li><a href="#PREFERRED_TO_TERMS"><abbr title="PREFERRED_TO_TERMS"><span class="sideoverflow">PREFERRED_TO_TERMS</span></abbr></a></li> + <li><a href="#PREFERRED_TERMS"><abbr title="PREFERRED_TERMS"><span class="sideoverflow">PREFERRED_TERMS</span></abbr></a></li> + <li><a href="#REPLACEMENT_TERMS"><abbr title="REPLACEMENT_TERMS"><span class="sideoverflow">REPLACEMENT_TERMS</span></abbr></a></li> + <li><a href="#REPLACED_BY"><abbr title="REPLACED_BY"><span class="sideoverflow">REPLACED_BY</span></abbr></a></li> + <li><a href="#TRANSLATION_TERMS"><abbr title="TRANSLATION_TERMS"><span class="sideoverflow">TRANSLATION_TERMS</span></abbr></a></li> + <li><a href="#TRANSLATED_TERMS"><abbr title="TRANSLATED_TERMS"><span class="sideoverflow">TRANSLATED_TERMS</span></abbr></a></li> + <li><a href="#ISA"><abbr title="ISA"><span class="sideoverflow">ISA</span></abbr></a></li> + <li><a href="#CLASSIFIES"><abbr title="CLASSIFIES"><span class="sideoverflow">CLASSIFIES</span></abbr></a></li> + <li><a href="#VALID_VALUES"><abbr title="VALID_VALUES"><span class="sideoverflow">VALID_VALUES</span></abbr></a></li> + <li><a href="#VALID_VALUES_FOR"><abbr title="VALID_VALUES_FOR"><span class="sideoverflow">VALID_VALUES_FOR</span></abbr></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="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_Relation.html">Relation</a></li> + </ol> + + <h1 class="page-header">Relation <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </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" id="SEE_ALSO">SEE_ALSO</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="SYNONYMS">SYNONYMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="ANTONYMS">ANTONYMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="PREFERRED_TO_TERMS">PREFERRED_TO_TERMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="PREFERRED_TERMS">PREFERRED_TERMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="REPLACEMENT_TERMS">REPLACEMENT_TERMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="REPLACED_BY">REPLACED_BY</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="TRANSLATION_TERMS">TRANSLATION_TERMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="TRANSLATED_TERMS">TRANSLATED_TERMS</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="ISA">ISA</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="CLASSIFIES">CLASSIFIES</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="VALID_VALUES">VALID_VALUES</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="VALID_VALUES_FOR">VALID_VALUES_FOR</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/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_RelationshipCategory.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_RelationshipCategory.html b/1.1.0/api/v2/json_RelationshipCategory.html index e4329b6..0c3915c 100644 --- a/1.1.0/api/v2/json_RelationshipCategory.html +++ b/1.1.0/api/v2/json_RelationshipCategory.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,10 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#ASSOCIATION"><abbr title="ASSOCIATION"><span class="sideoverflow">ASSOCIATION</span></abbr></a></li> + <li><a href="#AGGREGATION"><abbr title="AGGREGATION"><span class="sideoverflow">AGGREGATION</span></abbr></a></li> + <li><a href="#COMPOSITION"><abbr title="COMPOSITION"><span class="sideoverflow">COMPOSITION</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -65,8 +69,10 @@ <p>The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. -ASSOCIATION is a relationship with no containment. +<p> +ASSOCIATION is a relationship with no containment. <br> COMPOSITION and AGGREGATION are containment relationships. +<p> The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independant.</p> @@ -84,15 +90,15 @@ of the container and children are totally independant.</p> </thead> <tbody> <tr> - <td><span class="value-value">ASSOCIATION</span></td> + <td><span class="value-value" id="ASSOCIATION">ASSOCIATION</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">AGGREGATION</span></td> + <td><span class="value-value" id="AGGREGATION">AGGREGATION</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">COMPOSITION</span></td> + <td><span class="value-value" id="COMPOSITION">COMPOSITION</span></td> <td><span class="value-description"></span></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_RoundingMode.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_RoundingMode.html b/1.1.0/api/v2/json_RoundingMode.html new file mode 100644 index 0000000..cdd2d16 --- /dev/null +++ b/1.1.0/api/v2/json_RoundingMode.html @@ -0,0 +1,155 @@ +<!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: RoundingMode</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/enunciate.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: RoundingMode</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="#UP"><abbr title="UP"><span class="sideoverflow">UP</span></abbr></a></li> + <li><a href="#DOWN"><abbr title="DOWN"><span class="sideoverflow">DOWN</span></abbr></a></li> + <li><a href="#CEILING"><abbr title="CEILING"><span class="sideoverflow">CEILING</span></abbr></a></li> + <li><a href="#FLOOR"><abbr title="FLOOR"><span class="sideoverflow">FLOOR</span></abbr></a></li> + <li><a href="#HALF_UP"><abbr title="HALF_UP"><span class="sideoverflow">HALF_UP</span></abbr></a></li> + <li><a href="#HALF_DOWN"><abbr title="HALF_DOWN"><span class="sideoverflow">HALF_DOWN</span></abbr></a></li> + <li><a href="#HALF_EVEN"><abbr title="HALF_EVEN"><span class="sideoverflow">HALF_EVEN</span></abbr></a></li> + <li><a href="#UNNECESSARY"><abbr title="UNNECESSARY"><span class="sideoverflow">UNNECESSARY</span></abbr></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="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_RoundingMode.html">RoundingMode</a></li> + </ol> + + <h1 class="page-header">RoundingMode <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </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" id="UP">UP</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="DOWN">DOWN</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="CEILING">CEILING</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="FLOOR">FLOOR</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="HALF_UP">HALF_UP</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="HALF_DOWN">HALF_DOWN</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="HALF_EVEN">HALF_EVEN</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="UNNECESSARY">UNNECESSARY</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/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_SavedSearchType.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_SavedSearchType.html b/1.1.0/api/v2/json_SavedSearchType.html new file mode 100644 index 0000000..8f81138 --- /dev/null +++ b/1.1.0/api/v2/json_SavedSearchType.html @@ -0,0 +1,125 @@ +<!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: SavedSearchType</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/enunciate.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: SavedSearchType</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="#BASIC"><abbr title="BASIC"><span class="sideoverflow">BASIC</span></abbr></a></li> + <li><a href="#ADVANCED"><abbr title="ADVANCED"><span class="sideoverflow">ADVANCED</span></abbr></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="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_SavedSearchType.html">SavedSearchType</a></li> + </ol> + + <h1 class="page-header">SavedSearchType <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </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" id="BASIC">BASIC</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="ADVANCED">ADVANCED</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/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_SearchFilter.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_SearchFilter.html b/1.1.0/api/v2/json_SearchFilter.html index 15a6253..7e2006c 100644 --- a/1.1.0/api/v2/json_SearchFilter.html +++ b/1.1.0/api/v2/json_SearchFilter.html @@ -79,16 +79,16 @@ </thead> <tbody> <tr> - <td> <span class="property-name">params</span> + <td> <span id="prop-getCount" class="property-name">getCount</span> </td> - <td> <span class="datatype-reference">map of array of string + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">startIndex</span> + <td> <span id="prop-maxRows" class="property-name">maxRows</span> </td> <td> <span class="datatype-reference">number </span> @@ -97,36 +97,36 @@ </td> </tr> <tr> - <td> <span class="property-name">maxRows</span> + <td> <span id="prop-params" class="property-name">params</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">map of array of string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">getCount</span> + <td> <span id="prop-sortBy" class="property-name">sortBy</span> </td> - <td> <span class="datatype-reference">boolean + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">sortBy</span> + <td> <span id="prop-sortType" class="property-name">sortType</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">sortType</span> + <td> <span id="prop-startIndex" class="property-name">startIndex</span> </td> - <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> @@ -138,15 +138,15 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ + "getCount" : true, + "maxRows" : 12345, "params" : { "property1" : [ "...", "..." ], "property2" : [ "...", "..." ] }, - "startIndex" : 12345, - "maxRows" : 12345, - "getCount" : true, "sortBy" : "...", - "sortType" : "ASC" + "sortType" : "DESC", + "startIndex" : 12345 }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_SearchParameters.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_SearchParameters.html b/1.1.0/api/v2/json_SearchParameters.html index ccf9d46..8e009cd 100644 --- a/1.1.0/api/v2/json_SearchParameters.html +++ b/1.1.0/api/v2/json_SearchParameters.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -79,7 +79,16 @@ </thead> <tbody> <tr> - <td> <span class="property-name">query</span> + <td> <span id="prop-attributes" class="property-name">attributes</span> +</td> + <td> <span class="datatype-reference">array of string +</span> +</td> + <td> <span class="property-description">Attribute values included in the results</span> +</td> + </tr> + <tr> + <td> <span id="prop-classification" class="property-name">classification</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,25 +97,34 @@ </td> </tr> <tr> - <td> <span class="property-name">typeName</span> + <td> <span id="prop-entityFilters" class="property-name">entityFilters</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a> +</span> +</td> + <td> <span class="property-description">Entity attribute filters for the type (if type name is specified)</span> +</td> + </tr> + <tr> + <td> <span id="prop-excludeDeletedEntities" class="property-name">excludeDeletedEntities</span> +</td> + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">classification</span> + <td> <span id="prop-includeClassificationAttributes" class="property-name">includeClassificationAttributes</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">excludeDeletedEntities</span> + <td> <span id="prop-includeSubClassifications" class="property-name">includeSubClassifications</span> </td> <td> <span class="datatype-reference">boolean </span> @@ -115,7 +133,16 @@ </td> </tr> <tr> - <td> <span class="property-name">limit</span> + <td> <span id="prop-includeSubTypes" class="property-name">includeSubTypes</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-limit" class="property-name">limit</span> </td> <td> <span class="datatype-reference">number </span> @@ -124,7 +151,7 @@ </td> </tr> <tr> - <td> <span class="property-name">offset</span> + <td> <span id="prop-offset" class="property-name">offset</span> </td> <td> <span class="datatype-reference">number </span> @@ -133,16 +160,16 @@ </td> </tr> <tr> - <td> <span class="property-name">entityFilters</span> + <td> <span id="prop-query" class="property-name">query</span> </td> - <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a> + <td> <span class="datatype-reference">string </span> </td> - <td> <span class="property-description">Entity attribute filters for the type (if type name is specified)</span> + <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">tagFilters</span> + <td> <span id="prop-tagFilters" class="property-name">tagFilters</span> </td> <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a> </span> @@ -151,12 +178,21 @@ </td> </tr> <tr> - <td> <span class="property-name">attributes</span> + <td> <span id="prop-termName" class="property-name">termName</span> </td> - <td> <span class="datatype-reference">array of string + <td> <span class="datatype-reference">string </span> </td> - <td> <span class="property-description">Attribute values included in the results</span> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-typeName" class="property-name">typeName</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> </td> </tr> </tbody> @@ -165,27 +201,31 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "query" : "...", - "typeName" : "...", + "attributes" : [ "...", "..." ], "classification" : "...", - "excludeDeletedEntities" : true, - "limit" : 12345, - "offset" : 12345, "entityFilters" : { "attributeName" : "...", - "operator" : "EQ", "attributeValue" : "...", "condition" : "AND", - "criterion" : [ { }, { } ] + "criterion" : [ { }, { } ], + "operator" : "LIKE" }, + "excludeDeletedEntities" : true, + "includeClassificationAttributes" : true, + "includeSubClassifications" : true, + "includeSubTypes" : true, + "limit" : 12345, + "offset" : 12345, + "query" : "...", "tagFilters" : { "attributeName" : "...", - "operator" : "IN", "attributeValue" : "...", - "condition" : "AND", - "criterion" : [ { }, { } ] + "condition" : "OR", + "criterion" : [ { }, { } ], + "operator" : "LT" }, - "attributes" : [ "...", "..." ] + "termName" : "...", + "typeName" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_Status.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_Status.html b/1.1.0/api/v2/json_Status.html index 7eb0987..e699666 100644 --- a/1.1.0/api/v2/json_Status.html +++ b/1.1.0/api/v2/json_Status.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,9 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#ACTIVE"><abbr title="ACTIVE"><span class="sideoverflow">ACTIVE</span></abbr></a></li> + <li><a href="#DELETED"><abbr title="DELETED"><span class="sideoverflow">DELETED</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -78,11 +81,11 @@ </thead> <tbody> <tr> - <td><span class="value-value">ACTIVE</span></td> + <td><span class="value-value" id="ACTIVE">ACTIVE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">DELETED</span></td> + <td><span class="value-value" id="DELETED">DELETED</span></td> <td><span class="value-description"></span></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_Status_AtlasRelationship.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_Status_AtlasRelationship.html b/1.1.0/api/v2/json_Status_AtlasRelationship.html index f455e2b..b7dda4f 100644 --- a/1.1.0/api/v2/json_Status_AtlasRelationship.html +++ b/1.1.0/api/v2/json_Status_AtlasRelationship.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,9 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#ACTIVE"><abbr title="ACTIVE"><span class="sideoverflow">ACTIVE</span></abbr></a></li> + <li><a href="#DELETED"><abbr title="DELETED"><span class="sideoverflow">DELETED</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -78,11 +81,11 @@ </thead> <tbody> <tr> - <td><span class="value-value">ACTIVE</span></td> + <td><span class="value-value" id="ACTIVE">ACTIVE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">DELETED</span></td> + <td><span class="value-value" id="DELETED">DELETED</span></td> <td><span class="value-description"></span></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_TimeBoundary.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_TimeBoundary.html b/1.1.0/api/v2/json_TimeBoundary.html index 3d9b5d5..a58d9be 100644 --- a/1.1.0/api/v2/json_TimeBoundary.html +++ b/1.1.0/api/v2/json_TimeBoundary.html @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">startTime</span> + <td> <span id="prop-endTime" class="property-name">endTime</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,7 +88,7 @@ </td> </tr> <tr> - <td> <span class="property-name">endTime</span> + <td> <span id="prop-startTime" class="property-name">startTime</span> </td> <td> <span class="datatype-reference">string </span> @@ -97,7 +97,7 @@ </td> </tr> <tr> - <td> <span class="property-name">timeZone</span> + <td> <span id="prop-timeZone" class="property-name">timeZone</span> </td> <td> <span class="datatype-reference">string </span> @@ -111,8 +111,8 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "startTime" : "...", "endTime" : "...", + "startTime" : "...", "timeZone" : "..." }</pre> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_TimeZone.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_TimeZone.html b/1.1.0/api/v2/json_TimeZone.html new file mode 100644 index 0000000..5e646a3 --- /dev/null +++ b/1.1.0/api/v2/json_TimeZone.html @@ -0,0 +1,191 @@ +<!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: TimeZone</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/enunciate.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: TimeZone</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_json.html">JSON</a></li> + <li class="dropdown"><a href="json_TimeZone.html">TimeZone</a></li> + </ol> + + <h1 class="page-header">TimeZone <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Abstract Type</dt> + <dd></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span id="prop-DSTSavings" class="property-name">DSTSavings</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-ID" class="property-name">ID</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-availableIDs" class="property-name">availableIDs</span> +</td> + <td> <span class="datatype-reference">array of string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-default" class="property-name">default</span> +</td> + <td> <span class="datatype-reference"><a href="json_TimeZone.html">TimeZone</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-displayName" class="property-name">displayName</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-rawOffset" class="property-name">rawOffset</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div> + + <pre class="prettyprint language-js example">{ + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { }, + "displayName" : "...", + "rawOffset" : 12345 + }, + "displayName" : "...", + "rawOffset" : 12345 +}</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/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_TypeCategory.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_TypeCategory.html b/1.1.0/api/v2/json_TypeCategory.html index 29ff07f..a484f76 100644 --- a/1.1.0/api/v2/json_TypeCategory.html +++ b/1.1.0/api/v2/json_TypeCategory.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,16 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#PRIMITIVE"><abbr title="PRIMITIVE"><span class="sideoverflow">PRIMITIVE</span></abbr></a></li> + <li><a href="#OBJECT_ID_TYPE"><abbr title="OBJECT_ID_TYPE"><span class="sideoverflow">OBJECT_ID_TYPE</span></abbr></a></li> + <li><a href="#ENUM"><abbr title="ENUM"><span class="sideoverflow">ENUM</span></abbr></a></li> + <li><a href="#STRUCT"><abbr title="STRUCT"><span class="sideoverflow">STRUCT</span></abbr></a></li> + <li><a href="#CLASSIFICATION"><abbr title="CLASSIFICATION"><span class="sideoverflow">CLASSIFICATION</span></abbr></a></li> + <li><a href="#ENTITY"><abbr title="ENTITY"><span class="sideoverflow">ENTITY</span></abbr></a></li> + <li><a href="#ARRAY"><abbr title="ARRAY"><span class="sideoverflow">ARRAY</span></abbr></a></li> + <li><a href="#MAP"><abbr title="MAP"><span class="sideoverflow">MAP</span></abbr></a></li> + <li><a href="#RELATIONSHIP"><abbr title="RELATIONSHIP"><span class="sideoverflow">RELATIONSHIP</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -78,39 +88,39 @@ </thead> <tbody> <tr> - <td><span class="value-value">PRIMITIVE</span></td> + <td><span class="value-value" id="PRIMITIVE">PRIMITIVE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">OBJECT_ID_TYPE</span></td> + <td><span class="value-value" id="OBJECT_ID_TYPE">OBJECT_ID_TYPE</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">ENUM</span></td> + <td><span class="value-value" id="ENUM">ENUM</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">STRUCT</span></td> + <td><span class="value-value" id="STRUCT">STRUCT</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">CLASSIFICATION</span></td> + <td><span class="value-value" id="CLASSIFICATION">CLASSIFICATION</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">ENTITY</span></td> + <td><span class="value-value" id="ENTITY">ENTITY</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">ARRAY</span></td> + <td><span class="value-value" id="ARRAY">ARRAY</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">MAP</span></td> + <td><span class="value-value" id="MAP">MAP</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">RELATIONSHIP</span></td> + <td><span class="value-value" id="RELATIONSHIP">RELATIONSHIP</span></td> <td><span class="value-description"></span></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/ns0.xsd ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/ns0.xsd b/1.1.0/api/v2/ns0.xsd index f0a4003..b6d1794 100644 --- a/1.1.0/api/v2/ns0.xsd +++ b/1.1.0/api/v2/ns0.xsd @@ -111,11 +111,29 @@ </xs:element> <xs:element name="validityPeriods" type="timeBoundary" minOccurs="0" maxOccurs="unbounded"> </xs:element> + <xs:element name="entityStatus" type="status" minOccurs="0"> + </xs:element> + <xs:element name="removePropagationsOnEntityDelete" type="xs:boolean" minOccurs="0"> + </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> +<xs:simpleType name="status"> + <xs:annotation> + <xs:documentation> + <![CDATA[Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.]]> + </xs:documentation> + </xs:annotation> + <xs:restriction base="xs:string"> + + <xs:enumeration value="ACTIVE"/> + + <xs:enumeration value="DELETED"/> + </xs:restriction> +</xs:simpleType> + <xs:complexType name="atlasStruct"> <xs:annotation> <xs:documentation> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/resource_DiscoveryREST.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/resource_DiscoveryREST.html b/1.1.0/api/v2/resource_DiscoveryREST.html index e35ff90..cea178c 100644 --- a/1.1.0/api/v2/resource_DiscoveryREST.html +++ b/1.1.0/api/v2/resource_DiscoveryREST.html @@ -175,8 +175,12 @@ without any results</span></td> <h5>Request</h5> <pre> GET /v2/search/attribute +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -296,8 +300,12 @@ without any results</span></td> <h5>Request</h5> <pre> GET /v2/search/basic +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -504,8 +512,12 @@ without any results</span></td> <h5>Request</h5> <pre> GET /v2/search/dsl +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -613,8 +625,12 @@ without any results</span></td> <h5>Request</h5> <pre> GET /v2/search/fulltext +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -739,8 +755,12 @@ Content-Type: application/json;charset=UTF-8 <h5>Request</h5> <pre> GET /v2/search/relationship +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -807,8 +827,12 @@ Content-Type: application/json;charset=UTF-8 <h5>Request</h5> <pre> GET /v2/search/saved +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -998,7 +1022,11 @@ Content-Type: application/json;charset=UTF-8 <h5>Request</h5> <pre> DELETE /v2/search/saved/{guid} +Content-Type: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -1066,8 +1094,12 @@ HTTP/1.1 204 No Content <h5>Request</h5> <pre> GET /v2/search/saved/{name} +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -1139,8 +1171,12 @@ Content-Type: application/json;charset=UTF-8 <h5>Request</h5> <pre> GET /v2/search/saved/execute/{name} +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6"> @@ -1207,8 +1243,12 @@ Content-Type: application/json;charset=UTF-8 <h5>Request</h5> <pre> GET /v2/search/saved/execute/guid/{guid} +Content-Type: application/json;charset=UTF-8 Accept: application/json;charset=UTF-8 + <code class="prettyprint language-txt"> +... + </code> </pre> </div> <div class="col-md-6">
