atlas-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mad...@apache.org
Subject [23/27] incubator-atlas-website git commit: Added V2 REST API documentation (apoorvnaik via mneethiraj)
Date Sat, 18 Feb 2017 01:53:48 GMT
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/resource_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_DiscoveryREST.html b/api/v2/resource_DiscoveryREST.html
new file mode 100644
index 0000000..0954097
--- /dev/null
+++ b/api/v2/resource_DiscoveryREST.html
@@ -0,0 +1,470 @@
+<!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: DiscoveryREST</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: DiscoveryREST</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="#resource_DiscoveryREST_searchUsingDSL_GET">GET /v2/search/dsl</a></li>
+          <li><a href="#resource_DiscoveryREST_searchUsingFullText_GET">GET /v2/search/fulltext</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="resources.html">Resources</a></li>
+          <li class="dropdown"><a href="resource_DiscoveryREST.html">DiscoveryREST</a></li>
+        </ol>
+
+      <h1 class="page-header">DiscoveryREST <small>Resource</small></h1>
+
+      <p>REST interface for data discovery using dsl or full text search</p>
+
+      <div id="resource_DiscoveryREST_searchUsingDSL_GET">
+        <h3><span class="label label-default resource-method">GET</span>
<span class="resource-path">/v2/search/dsl <a href="../v2/search/dsl" class="glyphicon
glyphicon-new-window" target="_blank"></a></span></h3>
+
+        <p>Retrieve data for the specified DSL</p>
+
+        <table class="table resource-parameters">
+          <caption>Request Parameters</caption>
+          <thead>
+          <tr>
+            <th>name</th>
+            <th>type</th>
+            <th>description</th>
+            <th>constraints</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td><span class="parameter-name">limit</span></td>
+            <td>query</td>
+            <td><span class="parameter-description">limit the result set to only
include the specified number of entries</span></td>
+            <td><span class="parameter-constraints">int</span></td>
+          </tr>
+          <tr>
+            <td><span class="parameter-name">offset</span></td>
+            <td>query</td>
+            <td><span class="parameter-description">start offset of the result
set (useful for pagination)</span></td>
+            <td><span class="parameter-constraints">int</span></td>
+          </tr>
+          <tr>
+            <td><span class="parameter-name">query</span></td>
+            <td>query</td>
+            <td><span class="parameter-description">DSL query</span></td>
+            <td><span class="parameter-constraints">&nbsp;</span></td>
+          </tr>
+          </tbody>
+        </table>
+
+        <table class="table resource-response-codes">
+          <caption>Response Codes</caption>
+          <thead>
+          <tr>
+            <th>code</th>
+            <th>condition</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td><span class="label label-success response-code">200</span></td>
+            <td><span class="response-condition">On successful DSL execution
with some results, might return an empty list if execution succeeded
+without any results</span></td>
+          </tr>
+          <tr>
+            <td><span class="label label-warning response-code">400</span></td>
+            <td><span class="response-condition">Invalid DSL or query parameters</span></td>
+          </tr>
+          </tbody>
+        </table>
+
+        <table class="table resource-response-body">
+          <caption>Response Body</caption>
+          <thead>
+          <tr>
+            <th>media type</th>
+            <th>data type</th>
+            <th>description</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the
&quot;Accept: application/json&quot; HTTP header to request that this media type be
provided by the server."><span class="response-type">application/json</span></abbr></td>
+            <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+            <td><span class="response-description">Search results</span></td>
+          </tr>
+          </tbody>
+        </table>
+        <h4>Example</h4>
+
+        <div class="container-fluid example panel">
+          <div class="row panel-body">
+            <div class="col-md-6">
+              <h5>Request</h5>
+              <pre>
+GET /v2/search/dsl
+Accept: application/json
+
+              </pre>
+            </div>
+            <div class="col-md-6">
+              <h5>Response</h5>
+              <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+                <code class="prettyprint language-js">
+{
+  &quot;queryText&quot; : &quot;...&quot;,
+  &quot;queryType&quot; : &quot;FULL_TEXT&quot;,
+  &quot;entities&quot; : [ {
+    &quot;guid&quot; : &quot;...&quot;,
+    &quot;status&quot; : &quot;ACTIVE&quot;,
+    &quot;displayText&quot; : &quot;...&quot;,
+    &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+    &quot;atlasObjectId&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;uniqueAttributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      },
+      &quot;validGuid&quot; : true,
+      &quot;assignedGuid&quot; : true,
+      &quot;unAssignedGuid&quot; : true,
+      &quot;valid&quot; : true
+    },
+    &quot;typeName&quot; : &quot;...&quot;,
+    &quot;attributes&quot; : {
+      &quot;property1&quot; : { },
+      &quot;property2&quot; : { }
+    }
+  }, {
+    &quot;guid&quot; : &quot;...&quot;,
+    &quot;status&quot; : &quot;ACTIVE&quot;,
+    &quot;displayText&quot; : &quot;...&quot;,
+    &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+    &quot;atlasObjectId&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;uniqueAttributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      },
+      &quot;validGuid&quot; : true,
+      &quot;assignedGuid&quot; : true,
+      &quot;unAssignedGuid&quot; : true,
+      &quot;valid&quot; : true
+    },
+    &quot;typeName&quot; : &quot;...&quot;,
+    &quot;attributes&quot; : {
+      &quot;property1&quot; : { },
+      &quot;property2&quot; : { }
+    }
+  } ],
+  &quot;attributes&quot; : {
+    &quot;name&quot; : [ &quot;...&quot;, &quot;...&quot; ],
+    &quot;values&quot; : [ ]
+  },
+  &quot;fullTextResult&quot; : [ {
+    &quot;entity&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;status&quot; : &quot;DELETED&quot;,
+      &quot;displayText&quot; : &quot;...&quot;,
+      &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+      &quot;atlasObjectId&quot; : { },
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;attributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      }
+    },
+    &quot;score&quot; : 12345.0
+  }, {
+    &quot;entity&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;status&quot; : &quot;ACTIVE&quot;,
+      &quot;displayText&quot; : &quot;...&quot;,
+      &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+      &quot;atlasObjectId&quot; : { },
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;attributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      }
+    },
+    &quot;score&quot; : 12345.0
+  } ]
+}
+                </code>
+              </pre>
+            </div>
+          </div>
+        </div>
+      </div>
+
+      <div id="resource_DiscoveryREST_searchUsingFullText_GET">
+        <h3><span class="label label-default resource-method">GET</span>
<span class="resource-path">/v2/search/fulltext <a href="../v2/search/fulltext" class="glyphicon
glyphicon-new-window" target="_blank"></a></span></h3>
+
+        <p>Retrieve data for the specified fulltext query</p>
+
+        <table class="table resource-parameters">
+          <caption>Request Parameters</caption>
+          <thead>
+          <tr>
+            <th>name</th>
+            <th>type</th>
+            <th>description</th>
+            <th>constraints</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td><span class="parameter-name">limit</span></td>
+            <td>query</td>
+            <td><span class="parameter-description">limit the result set to only
include the specified number of entries</span></td>
+            <td><span class="parameter-constraints">int</span></td>
+          </tr>
+          <tr>
+            <td><span class="parameter-name">offset</span></td>
+            <td>query</td>
+            <td><span class="parameter-description">start offset of the result
set (useful for pagination)</span></td>
+            <td><span class="parameter-constraints">int</span></td>
+          </tr>
+          <tr>
+            <td><span class="parameter-name">query</span></td>
+            <td>query</td>
+            <td><span class="parameter-description">Fulltext query</span></td>
+            <td><span class="parameter-constraints">&nbsp;</span></td>
+          </tr>
+          </tbody>
+        </table>
+
+        <table class="table resource-response-codes">
+          <caption>Response Codes</caption>
+          <thead>
+          <tr>
+            <th>code</th>
+            <th>condition</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td><span class="label label-success response-code">200</span></td>
+            <td><span class="response-condition">On successful FullText lookup
with some results, might return an empty list if execution succeeded
+without any results</span></td>
+          </tr>
+          <tr>
+            <td><span class="label label-warning response-code">400</span></td>
+            <td><span class="response-condition">Invalid fulltext or query parameters</span></td>
+          </tr>
+          </tbody>
+        </table>
+
+        <table class="table resource-response-body">
+          <caption>Response Body</caption>
+          <thead>
+          <tr>
+            <th>media type</th>
+            <th>data type</th>
+            <th>description</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the
&quot;Accept: application/json&quot; HTTP header to request that this media type be
provided by the server."><span class="response-type">application/json</span></abbr></td>
+            <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+            <td><span class="response-description">Search results</span></td>
+          </tr>
+          </tbody>
+        </table>
+        <h4>Example</h4>
+
+        <div class="container-fluid example panel">
+          <div class="row panel-body">
+            <div class="col-md-6">
+              <h5>Request</h5>
+              <pre>
+GET /v2/search/fulltext
+Accept: application/json
+
+              </pre>
+            </div>
+            <div class="col-md-6">
+              <h5>Response</h5>
+              <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+                <code class="prettyprint language-js">
+{
+  &quot;queryText&quot; : &quot;...&quot;,
+  &quot;queryType&quot; : &quot;GREMLIN&quot;,
+  &quot;entities&quot; : [ {
+    &quot;guid&quot; : &quot;...&quot;,
+    &quot;status&quot; : &quot;DELETED&quot;,
+    &quot;displayText&quot; : &quot;...&quot;,
+    &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+    &quot;atlasObjectId&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;uniqueAttributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      },
+      &quot;validGuid&quot; : true,
+      &quot;assignedGuid&quot; : true,
+      &quot;unAssignedGuid&quot; : true,
+      &quot;valid&quot; : true
+    },
+    &quot;typeName&quot; : &quot;...&quot;,
+    &quot;attributes&quot; : {
+      &quot;property1&quot; : { },
+      &quot;property2&quot; : { }
+    }
+  }, {
+    &quot;guid&quot; : &quot;...&quot;,
+    &quot;status&quot; : &quot;DELETED&quot;,
+    &quot;displayText&quot; : &quot;...&quot;,
+    &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+    &quot;atlasObjectId&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;uniqueAttributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      },
+      &quot;validGuid&quot; : true,
+      &quot;assignedGuid&quot; : true,
+      &quot;unAssignedGuid&quot; : true,
+      &quot;valid&quot; : true
+    },
+    &quot;typeName&quot; : &quot;...&quot;,
+    &quot;attributes&quot; : {
+      &quot;property1&quot; : { },
+      &quot;property2&quot; : { }
+    }
+  } ],
+  &quot;attributes&quot; : {
+    &quot;name&quot; : [ &quot;...&quot;, &quot;...&quot; ],
+    &quot;values&quot; : [ ]
+  },
+  &quot;fullTextResult&quot; : [ {
+    &quot;entity&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;status&quot; : &quot;ACTIVE&quot;,
+      &quot;displayText&quot; : &quot;...&quot;,
+      &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+      &quot;atlasObjectId&quot; : { },
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;attributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      }
+    },
+    &quot;score&quot; : 12345.0
+  }, {
+    &quot;entity&quot; : {
+      &quot;guid&quot; : &quot;...&quot;,
+      &quot;status&quot; : &quot;DELETED&quot;,
+      &quot;displayText&quot; : &quot;...&quot;,
+      &quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot;
],
+      &quot;atlasObjectId&quot; : { },
+      &quot;typeName&quot; : &quot;...&quot;,
+      &quot;attributes&quot; : {
+        &quot;property1&quot; : { },
+        &quot;property2&quot; : { }
+      }
+    },
+    &quot;score&quot; : 12345.0
+  } ]
+}
+                </code>
+              </pre>
+            </div>
+          </div>
+        </div>
+      </div>
+
+        <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>


Mime
View raw message