admin_api.md

more Thu, 03 Jan 2019 12:20:04 -0800

Author: more
Date: Thu Jan  3 20:19:28 2019
New Revision: 1850265

URL: http://svn.apache.org/viewvc?rev=1850265&view=rev
Log:
KNOX-1726 - Document admin alias apis


Modified:
    knox/site/books/knox-1-3-0/user-guide.html
    knox/site/index.html
    knox/site/issue-management.html
    knox/site/licenses.html
    knox/site/mailing-lists.html
    knox/site/project-info.html
    knox/site/team.html
    knox/trunk/books/1.3.0/admin_api.md

Modified: knox/site/books/knox-1-3-0/user-guide.html
URL: 
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/user-guide.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/books/knox-1-3-0/user-guide.html (original)
+++ knox/site/books/knox-1-3-0/user-guide.html Thu Jan  3 20:19:28 2019
@@ -2461,6 +2461,77 @@ keytool -keystore gateway.jks -storepass
   </tr>
 
 </table>
+<table>
+  <thead>
+    <tr>
+      <th>Resource </th>
+      <th>Operation </th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>aliases/{topology}/{alias} </td>
+      <td>PUT </td>
+      <td>Add alias for a given topology</td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Request </td>
+      <td>curl -ik -u admin:admin-password -H &ldquo;Content-Type: 
application/json&rdquo;<br/>-d &ldquo;value=mysecret&rdquo; -X PUT 
&lsquo;{GatewayAPI}/sandbox/myalias&rsquo;</td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Response </td>
+      <td><code>{ &quot;created&quot; : { &quot;topology&quot;: 
&quot;sandbox&quot;, &quot;alias&quot;: &quot;putalias&quot; } }</code></td>
+    </tr>
+    <tr>
+      <td>aliases/{topology}/{alias} </td>
+      <td>POST </td>
+      <td>Add alias for a given topology</td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Request </td>
+      <td><code>curl -ik -u admin:admin-password -d &quot;value=mysecret&quot; 
-X POST &#39;{GatewayAPI}/sandbox/myalias&#39;</code></td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Response </td>
+      <td><code>{ &quot;created&quot; : { &quot;topology&quot;: 
&quot;sandbox&quot;, &quot;alias&quot;: &quot;putalias&quot; } }</code></td>
+    </tr>
+    <tr>
+      <td>aliases/{topology} </td>
+      <td>GET </td>
+      <td>Get all aliases for a given topology</td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Request </td>
+      <td><code>curl -ik -u admin:admin-password -X GET 
&#39;{GatewayAPI}/aliases/sandbox&#39;</code></td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Response </td>
+      
<td><code>{&quot;topology&quot;:&quot;sandbox&quot;,&quot;aliases&quot;:[&quot;myalias&quot;,&quot;encryptquerystring&quot;]}</code></td>
+    </tr>
+    <tr>
+      <td>aliases/{topology}/{alias} </td>
+      <td>DELETE </td>
+      <td>Delete alias for a given topology</td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Request </td>
+      <td><code>curl -ik -u admin:admin-password -X DELETE 
&#39;{GatewayAPI}/aliases/sandbox/myalias&#39;</code></td>
+    </tr>
+    <tr>
+      <td> </td>
+      <td>Example Response </td>
+      <td><code>{ &quot;deleted&quot; : { &quot;topology&quot;: 
&quot;sandbox&quot;, &quot;alias&quot;: &quot;myalias&quot; } }</code></td>
+    </tr>
+  </tbody>
+</table>
 <h3><a id="X-Forwarded-*+Headers+Support">X-Forwarded-* Headers Support</a> <a 
href="#X-Forwarded-*+Headers+Support"><img 
src="markbook-section-link.png"/></a></h3>
 <p>Out-of-the-box Knox provides support for some <code>X-Forwarded-*</code> 
headers through the use of a Servlet Filter. Specifically the headers 
handled/populated by Knox are:</p>
 <ul>

Modified: knox/site/index.html
URL: 
http://svn.apache.org/viewvc/knox/site/index.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Thu Jan  3 20:19:28 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
src/site/markdown/index.md at 2019-01-02
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
src/site/markdown/index.md at 2019-01-03
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20190102" />
+    <meta name="Date-Revision-yyyymmdd" content="20190103" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Announcing Apache Knox 1.2.0!</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-02</li>
+        <li id="publishDate">Last Published: 2019-01-03</li>
         </ul>
       </div>
       <div class="row-fluid">

Modified: knox/site/issue-management.html
URL: 
http://svn.apache.org/viewvc/knox/site/issue-management.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/issue-management.html (original)
+++ knox/site/issue-management.html Thu Jan  3 20:19:28 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management
 at 2019-01-02
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management
 at 2019-01-03
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20190102" />
+    <meta name="Date-Revision-yyyymmdd" content="20190103" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Issue Management</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-02</li>
+        <li id="publishDate">Last Published: 2019-01-03</li>
         </ul>
       </div>
       <div class="row-fluid">

Modified: knox/site/licenses.html
URL: 
http://svn.apache.org/viewvc/knox/site/licenses.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/licenses.html (original)
+++ knox/site/licenses.html Thu Jan  3 20:19:28 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at 
2019-01-02
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at 
2019-01-03
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20190102" />
+    <meta name="Date-Revision-yyyymmdd" content="20190103" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project Licenses</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-02</li>
+        <li id="publishDate">Last Published: 2019-01-03</li>
         </ul>
       </div>
       <div class="row-fluid">

Modified: knox/site/mailing-lists.html
URL: 
http://svn.apache.org/viewvc/knox/site/mailing-lists.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/mailing-lists.html (original)
+++ knox/site/mailing-lists.html Thu Jan  3 20:19:28 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists 
at 2019-01-02
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists 
at 2019-01-03
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20190102" />
+    <meta name="Date-Revision-yyyymmdd" content="20190103" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project Mailing Lists</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-02</li>
+        <li id="publishDate">Last Published: 2019-01-03</li>
         </ul>
       </div>
       <div class="row-fluid">

Modified: knox/site/project-info.html
URL: 
http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Thu Jan  3 20:19:28 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
 at 2019-01-02
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
 at 2019-01-03
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20190102" />
+    <meta name="Date-Revision-yyyymmdd" content="20190103" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project Information</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-02</li>
+        <li id="publishDate">Last Published: 2019-01-03</li>
         </ul>
       </div>
       <div class="row-fluid">

Modified: knox/site/team.html
URL: 
http://svn.apache.org/viewvc/knox/site/team.html?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/site/team.html (original)
+++ knox/site/team.html Thu Jan  3 20:19:28 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at 
2019-01-02
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from 
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at 
2019-01-03
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20190102" />
+    <meta name="Date-Revision-yyyymmdd" content="20190103" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project Team</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-02</li>
+        <li id="publishDate">Last Published: 2019-01-03</li>
         </ul>
       </div>
       <div class="row-fluid">

Modified: knox/trunk/books/1.3.0/admin_api.md
URL: 
http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/admin_api.md?rev=1850265&r1=1850264&r2=1850265&view=diff
==============================================================================
--- knox/trunk/books/1.3.0/admin_api.md (original)
+++ knox/trunk/books/1.3.0/admin_api.md Thu Jan  3 20:19:28 2019
@@ -519,5 +519,20 @@ Please note that to access this API, the
 
 </table>
 
+Resource | Operation | Description
+---------|-----------|------------
+aliases/{topology}/{alias} | PUT | Add alias for a given topology
+    | Example Request | curl -ik -u admin:admin-password -H "Content-Type: 
application/json"<br/>-d "value=mysecret" -X PUT '{GatewayAPI}/sandbox/myalias'
+       | Example Response | `{ "created" : { "topology": "sandbox", "alias": 
"putalias" } }`
+aliases/{topology}/{alias} | POST | Add alias for a given topology
+    | Example Request | `curl -ik -u admin:admin-password -d "value=mysecret" 
-X POST '{GatewayAPI}/sandbox/myalias'`
+       | Example Response | `{ "created" : { "topology": "sandbox", "alias": 
"putalias" } }`
+aliases/{topology} | GET | Get all aliases for a given topology
+    | Example Request | `curl -ik -u admin:admin-password -X GET 
'{GatewayAPI}/aliases/sandbox'`
+       | Example Response | 
`{"topology":"sandbox","aliases":["myalias","encryptquerystring"]}`
+aliases/{topology}/{alias} | DELETE | Delete alias for a given topology
+    | Example Request | `curl -ik -u admin:admin-password -X DELETE 
'{GatewayAPI}/aliases/sandbox/myalias'`
+       | Example Response | `{ "deleted" : { "topology": "sandbox", "alias": 
"myalias" } }`
+

svn commit: r1850265 - in /knox: site/books/knox-1-3-0/user-guide.html site/index.html site/issue-management.html site/licenses.html site/mailing-lists.html site/project-info.html site/team.html trunk/books/1.3.0/admin_api.md

Reply via email to