You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/05/25 19:10:06 UTC

[incubator-nlpcraft-website] branch master updated: REST links and tools fixes/additions.

This is an automated email from the ASF dual-hosted git repository.

aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 7c0b4ab  REST links and tools fixes/additions.
7c0b4ab is described below

commit 7c0b4ab3b4ded0ad44a3ca048bca48aa7918e7fb
Author: Aaron Radzinzski <ar...@datalingvo.com>
AuthorDate: Mon May 25 12:09:55 2020 -0700

    REST links and tools fixes/additions.
---
 _layouts/blog.html                                 |  4 +-
 _layouts/documentation.html                        | 22 ++++++++
 basic-concepts.html                                |  2 +-
 examples/alarm_clock.html                          |  4 +-
 examples/light_switch.html                         |  4 +-
 examples/weather_bot.html                          |  4 +-
 getting-started.html                               |  2 +-
 .../weather_bot.html => tools/embedded_probe.html  | 17 ++-----
 .../weather_bot.html => tools/sql_model_gen.html   | 17 ++-----
 .../weather_bot.html => tools/test_framework.html  | 17 ++-----
 using-rest.html                                    | 58 ++++++++--------------
 11 files changed, 66 insertions(+), 85 deletions(-)

diff --git a/_layouts/blog.html b/_layouts/blog.html
index 05c4c7a..ffc35c8 100644
--- a/_layouts/blog.html
+++ b/_layouts/blog.html
@@ -56,8 +56,8 @@ layout: default
                     </li>
                     <li>
                         <img alt="" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-                        href="https://nlpcraft.docs.apiary.io"
-                        target="apiary">REST API</a>
+                        href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+                        target="github">REST API</a>
                     </li>
                     <li>
                         <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/_layouts/documentation.html b/_layouts/documentation.html
index 26a8c0c..c95429e 100644
--- a/_layouts/documentation.html
+++ b/_layouts/documentation.html
@@ -105,6 +105,28 @@ layout: interior
                 <a href="/integrations.html">Integrations</a>
                 {% endif %}
             </li>
+            <li class="side-nav-title">Tools</li>
+            <li>
+                {% if page.id == "alarm_clock" %}
+                <a class="active" href="/tools/test_framework.html">Test Framework</a>
+                {% else %}
+                <a href="/tools/test_framework.html">Test Framework</a>
+                {% endif %}
+            </li>
+            <li>
+                {% if page.id == "embedded_probe" %}
+                <a class="active" href="/tools/embedded_probe.html">Embedded Probe</a>
+                {% else %}
+                <a href="/tools/embedded_probe.html">Embedded Probe</a>
+                {% endif %}
+            </li>
+            <li>
+                {% if page.id == "sql_model_gen" %}
+                <a class="active" href="/tools/sql_model_gen.html">SQL Model Generator</a>
+                {% else %}
+                <a href="/tools/sql_model_gen.html">SQL Model Generator</a>
+                {% endif %}
+            </li>
             <li class="side-nav-title">Examples</li>
             <li>
                 {% if page.id == "alarm_clock" %}
diff --git a/basic-concepts.html b/basic-concepts.html
index eef8e61..c9b5220 100644
--- a/basic-concepts.html
+++ b/basic-concepts.html
@@ -240,7 +240,7 @@ id: basic_concepts
             Conversation management implementation is also smart enough to clear STM after certain
             period of time, i.e. it “forgets” the conversational context after few minutes of inactivity.
             Note also that conversational context can also be cleared explicitly
-            via <a href="https://nlpcraft.docs.apiary.io" target="apiary">REST API</a>.
+            via <a href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml" target="github">REST API</a>.
         </p>
     </section>
 </div>
diff --git a/examples/alarm_clock.html b/examples/alarm_clock.html
index 294eb4d..7de0229 100644
--- a/examples/alarm_clock.html
+++ b/examples/alarm_clock.html
@@ -424,8 +424,8 @@ class AlarmTest {
         </li>
         <li>
             <img alt="Apiary" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-            href="https://nlpcraft.docs.apiary.io"
-            target="apiary">REST API</a>
+            href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+            target="github">REST API</a>
         </li>
         <li>
             <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/examples/light_switch.html b/examples/light_switch.html
index 408eb89..f6e9438 100644
--- a/examples/light_switch.html
+++ b/examples/light_switch.html
@@ -394,8 +394,8 @@ class LightSwitchTest {
         </li>
         <li>
             <img alt="Apiary" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-            href="https://nlpcraft.docs.apiary.io"
-            target="apiary">REST API</a>
+            href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+            target="github">REST API</a>
         </li>
         <li>
             <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/examples/weather_bot.html b/examples/weather_bot.html
index ec2a335..bf86d96 100644
--- a/examples/weather_bot.html
+++ b/examples/weather_bot.html
@@ -50,8 +50,8 @@ id: weather_bot
         </li>
         <li>
             <img alt="Apiary" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-            href="https://nlpcraft.docs.apiary.io"
-            target="apiary">REST API</a>
+            href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+            target="github">REST API</a>
         </li>
         <li>
             <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/getting-started.html b/getting-started.html
index a5501e3..68715e2 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -202,7 +202,7 @@ id: getting_started
         <p>
             Now that we have signed in (access token <code>KMGWMQJ44</code>) we can go ahead and start asking natural language
             questions against our data model (<code>nlpcraft.weather.ex</code>). For this example we'll use
-            <a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><code>/ask/sync</code></a> REST call - a
+            <a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><code>/ask/sync</code></a> REST call - a
             call that submit the request and waits for its completion before returning the result.
         </p>
         <p>
diff --git a/examples/weather_bot.html b/tools/embedded_probe.html
similarity index 75%
copy from examples/weather_bot.html
copy to tools/embedded_probe.html
index ec2a335..6f3ab6b 100644
--- a/examples/weather_bot.html
+++ b/tools/embedded_probe.html
@@ -1,7 +1,7 @@
 ---
-active_crumb: Weather Bot <code><sub>ex</sub></code>
+active_crumb: Embedded Probe
 layout: documentation
-id: weather_bot
+id: embedded_probe
 ---
 
 <!--
@@ -24,15 +24,6 @@ id: weather_bot
 <div class="col-md-8 second-column">
     <section id="overview">
         <h2 class="section-title">Overview</h2>
-        <p>
-            This example demonstrates relatively complete NLI-based weather service with JSON output and a non-trivial
-            intent matching logic. It uses <a target="new" href="https://www.apixu.com">https://www.apixu.com</a>
-            REST service for the actual weather information.
-        </p>
-        <p>
-            Complexity: <span class="complexity-two-star"><i class="fas fa-star"></i><i class="fas fa-star"></i><i class="far fa-star"></i></span><br/>
-            Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/src/main/scala/org/apache/nlpcraft/examples/weather">GitHub</a>
-        </p>
     </section>
 </div>
 <div class="col-md-2 third-column">
@@ -50,8 +41,8 @@ id: weather_bot
         </li>
         <li>
             <img alt="Apiary" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-            href="https://nlpcraft.docs.apiary.io"
-            target="apiary">REST API</a>
+            href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+            target="github">REST API</a>
         </li>
         <li>
             <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/examples/weather_bot.html b/tools/sql_model_gen.html
similarity index 75%
copy from examples/weather_bot.html
copy to tools/sql_model_gen.html
index ec2a335..f180db5 100644
--- a/examples/weather_bot.html
+++ b/tools/sql_model_gen.html
@@ -1,7 +1,7 @@
 ---
-active_crumb: Weather Bot <code><sub>ex</sub></code>
+active_crumb: SQL Model Generator
 layout: documentation
-id: weather_bot
+id: sql_model_gen
 ---
 
 <!--
@@ -24,15 +24,6 @@ id: weather_bot
 <div class="col-md-8 second-column">
     <section id="overview">
         <h2 class="section-title">Overview</h2>
-        <p>
-            This example demonstrates relatively complete NLI-based weather service with JSON output and a non-trivial
-            intent matching logic. It uses <a target="new" href="https://www.apixu.com">https://www.apixu.com</a>
-            REST service for the actual weather information.
-        </p>
-        <p>
-            Complexity: <span class="complexity-two-star"><i class="fas fa-star"></i><i class="fas fa-star"></i><i class="far fa-star"></i></span><br/>
-            Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/src/main/scala/org/apache/nlpcraft/examples/weather">GitHub</a>
-        </p>
     </section>
 </div>
 <div class="col-md-2 third-column">
@@ -50,8 +41,8 @@ id: weather_bot
         </li>
         <li>
             <img alt="Apiary" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-            href="https://nlpcraft.docs.apiary.io"
-            target="apiary">REST API</a>
+            href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+            target="github">REST API</a>
         </li>
         <li>
             <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/examples/weather_bot.html b/tools/test_framework.html
similarity index 75%
copy from examples/weather_bot.html
copy to tools/test_framework.html
index ec2a335..a46a3fd 100644
--- a/examples/weather_bot.html
+++ b/tools/test_framework.html
@@ -1,7 +1,7 @@
 ---
-active_crumb: Weather Bot <code><sub>ex</sub></code>
+active_crumb: Test Framework
 layout: documentation
-id: weather_bot
+id: test_framework
 ---
 
 <!--
@@ -24,15 +24,6 @@ id: weather_bot
 <div class="col-md-8 second-column">
     <section id="overview">
         <h2 class="section-title">Overview</h2>
-        <p>
-            This example demonstrates relatively complete NLI-based weather service with JSON output and a non-trivial
-            intent matching logic. It uses <a target="new" href="https://www.apixu.com">https://www.apixu.com</a>
-            REST service for the actual weather information.
-        </p>
-        <p>
-            Complexity: <span class="complexity-two-star"><i class="fas fa-star"></i><i class="fas fa-star"></i><i class="far fa-star"></i></span><br/>
-            Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/src/main/scala/org/apache/nlpcraft/examples/weather">GitHub</a>
-        </p>
     </section>
 </div>
 <div class="col-md-2 third-column">
@@ -50,8 +41,8 @@ id: weather_bot
         </li>
         <li>
             <img alt="Apiary" class="quick-link-img mr-2" src="/images/apiary.svg"><a
-            href="https://nlpcraft.docs.apiary.io"
-            target="apiary">REST API</a>
+            href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"
+            target="github">REST API</a>
         </li>
         <li>
             <i class="fas fa-download mr-2"></i><a href="/download.html">Download</a>
diff --git a/using-rest.html b/using-rest.html
index a26de31..d01fa6a 100644
--- a/using-rest.html
+++ b/using-rest.html
@@ -35,20 +35,6 @@ id: rest
             data models. The result of data model processing travels all the way through the same chain of components
             back to the user application that made the original call.
         </p>
-        <p>
-            In this chapter we'll provide an overview on using REST API. Note that the full REST API specification
-            is hosted on <a href="https://nlpcraft.docs.apiary.io" target="apiary">apiary.io</a> where you can review
-            it and test with it against your localhost or remote NLPCraft installation.
-        </p>
-        <div class="bq warn">
-            <p>
-                <b>apiary.io <span class="amp">&amp;</span> localhost</b>
-            </p>
-            <p>
-                If you are using <a href="https://nlpcraft.docs.apiary.io" target="apiary">apiary.io</a> to test REST API against localhost make sure
-                to install Chrome Apiary extension. Note that this will only work in Chrome browser.
-            </p>
-        </div>
         <div class="bq info">
             <p>
                 If you downloaded ZIP archive the REST API specification is also available in
@@ -65,7 +51,7 @@ id: rest
         </p>
         <ul>
             <li>Maven/Grape/Gradle/SBT <a href="download.html#java-client">instructions</a></li>
-            <li>Latest <a target=_ href="https://apache.github.io/incubator-nlpcraft-java-client/apis/latest/index.html">Javadoc</a></li>
+            <li>Latest <a target=_ href="https://nlpcraft.apache.org/apis/java-client/latest/index.html">Javadoc</a></li>
             <li>Watch, star or fork <a target="github" href="https://github.com/apache/incubator-nlpcraft-java-client">GitHub Project</a></li>
         </ul>
 
@@ -152,11 +138,11 @@ id: rest
             </thead>
             <tbody>
                 <tr>
-                    <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/authentication"><nobr><code>/signin</code></nobr></a></td>
+                    <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/signin</code></nobr></a></td>
                     <td>Sign in and obtain <b>access token</b>.</td>
                 </tr>
                 <tr>
-                    <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/authentication"><nobr><code>/signout</code></nobr></a></td>
+                    <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/signout</code></nobr></a></td>
                     <td>Sign out and invalidate previously obtained <b>access token</b>.</td>
                 </tr>
             </tbody>
@@ -194,31 +180,31 @@ id: rest
             </thead>
             <tbody>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><nobr><code>/ask</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/ask</code></nobr></a></td>
                 <td>Submit the sentence to be processed <b>asynchronously</b>.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><nobr><code>/ask/sync</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/ask/sync</code></nobr></a></td>
                 <td>Submit the sentence to be processed <b>synchronously</b>. </td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><nobr><code>/check</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/check</code></nobr></a></td>
                 <td>Get statuses and results for previously submitted <code>/ask</code> requests.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><nobr><code>/cancel</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/cancel</code></nobr></a></td>
                 <td>
                     Remove results from the server memory.
                 </td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><nobr><code>/clear/conversation</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/clear/conversation</code></nobr></a></td>
                 <td>
                     Clear the conversation STM for current user and data model.
                 </td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/asking"><nobr><code>/clear/dialog</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/clear/dialog</code></nobr></a></td>
                 <td>
                     Clear the dialog flow for current user and data model.
                 </td>
@@ -240,23 +226,23 @@ id: rest
             </thead>
             <tbody>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/company/get</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/company/get</code></nobr></a></td>
                 <td>Gets current user company.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/company/add</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/company/add</code></nobr></a></td>
                 <td>Add new company.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/company/update</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/company/update</code></nobr></a></td>
                 <td>Update company information.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/company/delete</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/company/delete</code></nobr></a></td>
                 <td>Delete company.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/company/token/reset</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/company/token/reset</code></nobr></a></td>
                 <td>Reset company's authentication token.</td>
             </tr>
             </tbody>
@@ -276,31 +262,31 @@ id: rest
             </thead>
             <tbody>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/get</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/get</code></nobr></a></td>
                 <td>Get current user information.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/all</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/all</code></nobr></a></td>
                 <td>Get all users.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/add</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/add</code></nobr></a></td>
                 <td>Add new user.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/update</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/update</code></nobr></a></td>
                 <td>Update user information.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/delete</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/delete</code></nobr></a></td>
                 <td>Delete user.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/admin</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/admin</code></nobr></a></td>
                 <td>Change user administrative privileges.</td>
             </tr>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/users"><nobr><code>/user/passwd/reset</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/user/passwd/reset</code></nobr></a></td>
                 <td>
                     Reset the current user password.
                 </td>
@@ -322,7 +308,7 @@ id: rest
             </thead>
             <tbody>
             <tr>
-                <td><a target=apiary href="https://nlpcraft.docs.apiary.io/#reference/data-probes"><nobr><code>/probes/all</code></nobr></a></td>
+                <td><a target="github" href="https://github.com/apache/incubator-nlpcraft/blob/master/openapi/nlpcraft_swagger.yml"><nobr><code>/probes/all</code></nobr></a></td>
                 <td>Get information about connected probes.</td>
             </tr>
             </tbody>