unstick r1870917

Revision 1870917

Date:
2019/12/06 14:19:07
Author:
pzampino
Revision Log:
Corrected Alias API doc for 1.3.0
Files:

Legend:

 
Added
 
Removed
 
Modified
  • knox/site/books/knox-1-3-0/user-guide.html

     
    2617 2617 </td>
    2618 2618 </tr>
    2619 2619
    2620 <tr>
    2621 <td>aliases/{topology}</td>
    2622 <td>GET</td>
    2623 <td>Get the aliases associated with the specified topology.</td>
    2624 </tr>
    2625 <tr>
    2626 <td>&nbsp;</td>
    2627 <td>Example Request</td>
    2628 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox</pre></td>
    2629 </tr>
    2630 <tr>
    2631 <td>&nbsp;</td>
    2632 <td>Example Response</td>
    2633 <td>
    2634 <pre>
    2635 {
    2636 "topology":"sandbox",
    2637 "aliases":["myalias","encryptquerystring"]
    2638 }
    2639 </pre>
    2640 </td>
    2641 </tr>
    2642
    2643 <tr>
    2644 <td>aliases/{topology}/{alias}</td>
    2645 <td>PUT</td>
    2646 <td>Add the specified alias for the specified topology.</td>
    2647 </tr>
    2648 <tr>
    2649 <td>&nbsp;</td>
    2650 <td>Example Request</td>
    2651 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox/putalias -X PUT \
    2652 -H "Content-Type: application/json" \
    2653 -d "value=mysecret"</pre>
    2654 </td>
    2655 </tr>
    2656 <tr>
    2657 <td>&nbsp;</td>
    2658 <td>Example Response</td>
    2659 <td>
    2660 <pre>
    2661 {
    2662 "created" : {
    2663 "topology": "sandbox",
    2664 "alias": "putalias"
    2665 }
    2666 }</pre>
    2667 </td>
    2668 </tr>
    2669 <tr>
    2670 <td>&nbsp;</td>
    2671 <td>POST</td>
    2672 <td>Add the specified alias for the specified topology.</td>
    2673 </tr>
    2674 <tr>
    2675 <td>&nbsp;</td>
    2676 <td>Example Request</td>
    2677 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox/postalias -X POST \
    2678 -H "Content-Type: application/json" \
    2679 -d "value=mysecret"</pre>
    2680 </td>
    2681 </tr>
    2682 <tr>
    2683 <td>&nbsp;</td>
    2684 <td>Example Response</td>
    2685 <td>
    2686 <pre>
    2687 {
    2688 "created" : {
    2689 "topology": "sandbox",
    2690 "alias": "postalias"
    2691 }
    2692 }</pre>
    2693 </td>
    2694 </tr>
    2695 <tr>
    2696 <td>&nbsp;</td>
    2697 <td>DELETE</td>
    2698 <td>Remove the specified alias for the specified topology.</td>
    2699 </tr>
    2700 <tr>
    2701 <td>&nbsp;</td>
    2702 <td>Example Request</td>
    2703 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox/myalias -X DELETE</pre></td>
    2704 </tr>
    2705 <tr>
    2706 <td>&nbsp;</td>
    2707 <td>Example Response</td>
    2708 <td>
    2709 <pre>
    2710 {
    2711 "deleted" : {
    2712 "topology": "sandbox",
    2713 "alias": "myalias"
    2714 }
    2715 }</pre></td>
    2716 </tr>
    2717
    2620 2718 </table>
    2621 <table>
    2622 <thead>
    2623 <tr>
    2624 <th>Resource </th>
    2625 <th>Operation </th>
    2626 <th>Description</th>
    2627 </tr>
    2628 </thead>
    2629 <tbody>
    2630 <tr>
    2631 <td>aliases/{topology}/{alias} </td>
    2632 <td>PUT </td>
    2633 <td>Add alias for a given topology</td>
    2634 </tr>
    2635 <tr>
    2636 <td> </td>
    2637 <td>Example Request </td>
    2638 <td><code>curl -ik -u admin:admin-password -H &quot;Content-Type: application/json&quot; -d &quot;value=mysecret&quot; -X PUT &#39;{GatewayAPI}/aliases/sandbox/myalias&#39;</code></td>
    2639 </tr>
    2640 <tr>
    2641 <td> </td>
    2642 <td>Example Response </td>
    2643 <td><code>{ &quot;created&quot; : { &quot;topology&quot;: &quot;sandbox&quot;, &quot;alias&quot;: &quot;putalias&quot; } }</code></td>
    2644 </tr>
    2645 <tr>
    2646 <td>aliases/{topology}/{alias} </td>
    2647 <td>POST </td>
    2648 <td>Add alias for a given topology</td>
    2649 </tr>
    2650 <tr>
    2651 <td> </td>
    2652 <td>Example Request </td>
    2653 <td><code>curl -ik -u admin:admin-password -d &quot;value=mysecret&quot; -X POST &#39;{GatewayAPI}/aliases/sandbox/myalias&#39;</code></td>
    2654 </tr>
    2655 <tr>
    2656 <td> </td>
    2657 <td>Example Response </td>
    2658 <td><code>{ &quot;created&quot; : { &quot;topology&quot;: &quot;sandbox&quot;, &quot;alias&quot;: &quot;putalias&quot; } }</code></td>
    2659 </tr>
    2660 <tr>
    2661 <td>aliases/{topology} </td>
    2662 <td>GET </td>
    2663 <td>Get all aliases for a given topology</td>
    2664 </tr>
    2665 <tr>
    2666 <td> </td>
    2667 <td>Example Request </td>
    2668 <td><code>curl -ik -u admin:admin-password -X GET &#39;{GatewayAPI}/aliases/sandbox&#39;</code></td>
    2669 </tr>
    2670 <tr>
    2671 <td> </td>
    2672 <td>Example Response </td>
    2673 <td><code>{&quot;topology&quot;:&quot;sandbox&quot;,&quot;aliases&quot;:[&quot;myalias&quot;,&quot;encryptquerystring&quot;]}</code></td>
    2674 </tr>
    2675 <tr>
    2676 <td>aliases/{topology}/{alias} </td>
    2677 <td>DELETE </td>
    2678 <td>Delete alias for a given topology</td>
    2679 </tr>
    2680 <tr>
    2681 <td> </td>
    2682 <td>Example Request </td>
    2683 <td><code>curl -ik -u admin:admin-password -X DELETE &#39;{GatewayAPI}/aliases/sandbox/myalias&#39;</code></td>
    2684 </tr>
    2685 <tr>
    2686 <td> </td>
    2687 <td>Example Response </td>
    2688 <td><code>{ &quot;deleted&quot; : { &quot;topology&quot;: &quot;sandbox&quot;, &quot;alias&quot;: &quot;myalias&quot; } }</code></td>
    2689 </tr>
    2690 </tbody>
    2691 </table>
    2692 2719 <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>
    2693 2720 <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>
    2694 2721 <ul>
  • knox/site/index.html

     
    1 1 <!DOCTYPE html>
    2 2 <!--
    3 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/index.md at 2019-12-05
    3 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/index.md at 2019-12-06
    4 4 | Rendered using Apache Maven Fluido Skin 1.7
    5 5 -->
    6 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    7 7 <head>
    8 8 <meta charset="UTF-8" />
    9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191205" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191206" />
    11 11 <meta http-equiv="Content-Language" content="en" />
    12 12 <title>Knox Gateway &#x2013; Announcing Apache Knox 1.3.0!</title>
    13 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
     
    40 40
    41 41 <div id="breadcrumbs">
    42 42 <ul class="breadcrumb">
    43 <li id="publishDate">Last Published: 2019-12-05</li>
    43 <li id="publishDate">Last Published: 2019-12-06</li>
    44 44 </ul>
    45 45 </div>
    46 46 <div class="row-fluid">
  • knox/site/issue-management.html

     
    1 1 <!DOCTYPE html>
    2 2 <!--
    3 | 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-12-05
    3 | 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-12-06
    4 4 | Rendered using Apache Maven Fluido Skin 1.7
    5 5 -->
    6 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    7 7 <head>
    8 8 <meta charset="UTF-8" />
    9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191205" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191206" />
    11 11 <meta http-equiv="Content-Language" content="en" />
    12 12 <title>Knox Gateway &#x2013; Issue Management</title>
    13 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
     
    40 40
    41 41 <div id="breadcrumbs">
    42 42 <ul class="breadcrumb">
    43 <li id="publishDate">Last Published: 2019-12-05</li>
    43 <li id="publishDate">Last Published: 2019-12-06</li>
    44 44 </ul>
    45 45 </div>
    46 46 <div class="row-fluid">
  • knox/site/licenses.html

     
    1 1 <!DOCTYPE html>
    2 2 <!--
    3 | 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-12-05
    3 | 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-12-06
    4 4 | Rendered using Apache Maven Fluido Skin 1.7
    5 5 -->
    6 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    7 7 <head>
    8 8 <meta charset="UTF-8" />
    9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191205" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191206" />
    11 11 <meta http-equiv="Content-Language" content="en" />
    12 12 <title>Knox Gateway &#x2013; Project Licenses</title>
    13 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
     
    40 40
    41 41 <div id="breadcrumbs">
    42 42 <ul class="breadcrumb">
    43 <li id="publishDate">Last Published: 2019-12-05</li>
    43 <li id="publishDate">Last Published: 2019-12-06</li>
    44 44 </ul>
    45 45 </div>
    46 46 <div class="row-fluid">
  • knox/site/mailing-lists.html

     
    1 1 <!DOCTYPE html>
    2 2 <!--
    3 | 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-12-05
    3 | 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-12-06
    4 4 | Rendered using Apache Maven Fluido Skin 1.7
    5 5 -->
    6 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    7 7 <head>
    8 8 <meta charset="UTF-8" />
    9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191205" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191206" />
    11 11 <meta http-equiv="Content-Language" content="en" />
    12 12 <title>Knox Gateway &#x2013; Project Mailing Lists</title>
    13 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
     
    40 40
    41 41 <div id="breadcrumbs">
    42 42 <ul class="breadcrumb">
    43 <li id="publishDate">Last Published: 2019-12-05</li>
    43 <li id="publishDate">Last Published: 2019-12-06</li>
    44 44 </ul>
    45 45 </div>
    46 46 <div class="row-fluid">
  • knox/site/project-info.html

     
    1 1 <!DOCTYPE html>
    2 2 <!--
    3 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer at 2019-12-05
    3 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer at 2019-12-06
    4 4 | Rendered using Apache Maven Fluido Skin 1.7
    5 5 -->
    6 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    7 7 <head>
    8 8 <meta charset="UTF-8" />
    9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191205" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191206" />
    11 11 <meta http-equiv="Content-Language" content="en" />
    12 12 <title>Knox Gateway &#x2013; Project Information</title>
    13 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
     
    40 40
    41 41 <div id="breadcrumbs">
    42 42 <ul class="breadcrumb">
    43 <li id="publishDate">Last Published: 2019-12-05</li>
    43 <li id="publishDate">Last Published: 2019-12-06</li>
    44 44 </ul>
    45 45 </div>
    46 46 <div class="row-fluid">
  • knox/site/team.html

     
    1 1 <!DOCTYPE html>
    2 2 <!--
    3 | 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-12-05
    3 | 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-12-06
    4 4 | Rendered using Apache Maven Fluido Skin 1.7
    5 5 -->
    6 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    7 7 <head>
    8 8 <meta charset="UTF-8" />
    9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191205" />
    10 <meta name="Date-Revision-yyyymmdd" content="20191206" />
    11 11 <meta http-equiv="Content-Language" content="en" />
    12 12 <title>Knox Gateway &#x2013; Project Team</title>
    13 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
     
    40 40
    41 41 <div id="breadcrumbs">
    42 42 <ul class="breadcrumb">
    43 <li id="publishDate">Last Published: 2019-12-05</li>
    43 <li id="publishDate">Last Published: 2019-12-06</li>
    44 44 </ul>
    45 45 </div>
    46 46 <div class="row-fluid">
  • knox/trunk/books/1.3.0/admin_api.md

     
    517 517 </td>
    518 518 </tr>
    519 519
    520 <tr>
    521 <td>aliases/{topology}</td>
    522 <td>GET</td>
    523 <td>Get the aliases associated with the specified topology.</td>
    524 </tr>
    525 <tr>
    526 <td>&nbsp;</td>
    527 <td>Example Request</td>
    528 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox</pre></td>
    529 </tr>
    530 <tr>
    531 <td>&nbsp;</td>
    532 <td>Example Response</td>
    533 <td>
    534 <pre>
    535 {
    536 "topology":"sandbox",
    537 "aliases":["myalias","encryptquerystring"]
    538 }
    539 </pre>
    540 </td>
    541 </tr>
    542
    543 <tr>
    544 <td>aliases/{topology}/{alias}</td>
    545 <td>PUT</td>
    546 <td>Add the specified alias for the specified topology.</td>
    547 </tr>
    548 <tr>
    549 <td>&nbsp;</td>
    550 <td>Example Request</td>
    551 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox/putalias -X PUT \
    552 -H "Content-Type: application/json" \
    553 -d "value=mysecret"</pre>
    554 </td>
    555 </tr>
    556 <tr>
    557 <td>&nbsp;</td>
    558 <td>Example Response</td>
    559 <td>
    560 <pre>
    561 {
    562 "created" : {
    563 "topology": "sandbox",
    564 "alias": "putalias"
    565 }
    566 }</pre>
    567 </td>
    568 </tr>
    569 <tr>
    570 <td>&nbsp;</td>
    571 <td>POST</td>
    572 <td>Add the specified alias for the specified topology.</td>
    573 </tr>
    574 <tr>
    575 <td>&nbsp;</td>
    576 <td>Example Request</td>
    577 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox/postalias -X POST \
    578 -H "Content-Type: application/json" \
    579 -d "value=mysecret"</pre>
    580 </td>
    581 </tr>
    582 <tr>
    583 <td>&nbsp;</td>
    584 <td>Example Response</td>
    585 <td>
    586 <pre>
    587 {
    588 "created" : {
    589 "topology": "sandbox",
    590 "alias": "postalias"
    591 }
    592 }</pre>
    593 </td>
    594 </tr>
    595 <tr>
    596 <td>&nbsp;</td>
    597 <td>DELETE</td>
    598 <td>Remove the specified alias for the specified topology.</td>
    599 </tr>
    600 <tr>
    601 <td>&nbsp;</td>
    602 <td>Example Request</td>
    603 <td><pre>curl -iku admin:admin-password {GatewayAPI}/aliases/sandbox/myalias -X DELETE</pre></td>
    604 </tr>
    605 <tr>
    606 <td>&nbsp;</td>
    607 <td>Example Response</td>
    608 <td>
    609 <pre>
    610 {
    611 "deleted" : {
    612 "topology": "sandbox",
    613 "alias": "myalias"
    614 }
    615 }</pre></td>
    616 </tr>
    617
    520 618 </table>
    521 619
    522 Resource | Operation | Description
    523 ---------|-----------|------------
    524 aliases/{topology}/{alias} | PUT | Add alias for a given topology
    525 | Example Request | `curl -ik -u admin:admin-password -H "Content-Type: application/json" -d "value=mysecret" -X PUT '{GatewayAPI}/aliases/sandbox/myalias'`
    526 | Example Response | `{ "created" : { "topology": "sandbox", "alias": "putalias" } }`
    527 aliases/{topology}/{alias} | POST | Add alias for a given topology
    528 | Example Request | `curl -ik -u admin:admin-password -d "value=mysecret" -X POST '{GatewayAPI}/aliases/sandbox/myalias'`
    529 | Example Response | `{ "created" : { "topology": "sandbox", "alias": "putalias" } }`
    530 aliases/{topology} | GET | Get all aliases for a given topology
    531 | Example Request | `curl -ik -u admin:admin-password -X GET '{GatewayAPI}/aliases/sandbox'`
    532 | Example Response | `{"topology":"sandbox","aliases":["myalias","encryptquerystring"]}`
    533 aliases/{topology}/{alias} | DELETE | Delete alias for a given topology
    534 | Example Request | `curl -ik -u admin:admin-password -X DELETE '{GatewayAPI}/aliases/sandbox/myalias'`
    535 | Example Response | `{ "deleted" : { "topology": "sandbox", "alias": "myalias" } }`
    536 620
    537 621
    538