Author: tkurc
Date: Sat Feb 27 03:27:48 2016
New Revision: 1732599
URL: http://svn.apache.org/viewvc?rev=1732599&view=rev
Log:
NIFI-1556: updating rest-api for 0.5.1
Modified:
nifi/site/trunk/docs/nifi-docs/rest-api/index.html
Modified: nifi/site/trunk/docs/nifi-docs/rest-api/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/rest-api/index.html?rev=1732599&r1=1732598&r2=1732599&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/rest-api/index.html (original)
+++ nifi/site/trunk/docs/nifi-docs/rest-api/index.html Sat Feb 27 03:27:48 2016
@@ -15,7 +15,7 @@
-->
<html>
<head>
- <title>NiFi Rest Api-0.5.0</title>
+ <title>NiFi Rest Api-0.5.1</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<link rel="shortcut icon" href="images/nifi16.ico"/>
<script type="text/javascript"
src="../../nifi/js/jquery/jquery-2.1.1.min.js"></script>
@@ -460,7 +460,7 @@
<div class="header">
<img class="logo" src="images/bgNifiLogo.png" alt="NiFi Logo"/>
<div class="title">/nifi-api</div>
- <div class="sub-title">NiFi Rest Api 0.5.0</div>
+ <div class="sub-title">NiFi Rest Api 0.5.1</div>
<div class="clear"></div>
</div>
<div class="clear"></div>
@@ -822,6 +822,103 @@
<div class="endpoints">
+ <span class="path hidden">/access/download-token</span>
+
+ <div class="endpoint post">
+ <div class="operation-handle">
+ <div class="method">POST</div>
+ <div class="path mono"></div>
+ <div class="summary">Creates a single use access token for
downloading FlowFile content.</div>
+ <div class="clear"></div>
+ </div>
+
+<div class="operation hidden">
+
+ <div class="description">
+ The token returned is a base64 encoded string. It is valid for a
single request up to five minutes from being issued. It is used as a query
parameter name 'access_token'.
+ </div>
+
+ <div class="title">Request</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">consumes:</div><div
class="mono">application/x-www-form-urlencoded</div><div
class="clear"></div></div>
+
+ </div>
+
+
+
+ <div class="title">Response</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">produces:</div><div
class="mono">text/plain</div><div class="clear"></div></div>
+
+ </div>
+ <table>
+ <thead>
+ <tr>
+ <th>Status Code</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>200</td>
+ <td>
+
+
+
+ </td>
+ <td>successful operation</td>
+ </tr>
+
+ <tr>
+ <td>403</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Client is not authorized to make this request.</td>
+ </tr>
+
+ <tr>
+ <td>409</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Unable to create the download token because NiFi is not in
the appropriate state. (i.e. may not have any tokens to grant or be configured
to support username/password login)</td>
+ </tr>
+
+ <tr>
+ <td>500</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Unable to create download token because an unexpected
error occurred.</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <div class="title">Authorization</div>
+ <div class="authorization details">
+
+ </div>
+</div>
+ </div>
+
+
+
+
+</div>
+
+
+<div class="endpoints">
<span class="path hidden">/access/token</span>
<div class="endpoint post">
@@ -834,6 +931,10 @@
<div class="operation hidden">
+ <div class="description">
+ The token returned is formatted as a JSON Web Token (JWT). The token
is base64 encoded and comprised of three parts. The header, the body, and the
signature. The expiration of the token is a contained within the body. The
token can be used in the Authorization header in the format
'Authorization: Bearer <token>'.
+ </div>
+
<div class="title">Request</div>
<div class="mediatypes details">
@@ -950,6 +1051,103 @@
</tr>
</tbody>
+ </table>
+ <div class="title">Authorization</div>
+ <div class="authorization details">
+
+ </div>
+</div>
+ </div>
+
+
+
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/access/ui-extension-token</span>
+
+ <div class="endpoint post">
+ <div class="operation-handle">
+ <div class="method">POST</div>
+ <div class="path mono"></div>
+ <div class="summary">Creates a single use access token for
accessing a NiFi UI extension.</div>
+ <div class="clear"></div>
+ </div>
+
+<div class="operation hidden">
+
+ <div class="description">
+ The token returned is a base64 encoded string. It is valid for a
single request up to five minutes from being issued. It is used as a query
parameter name 'access_token'.
+ </div>
+
+ <div class="title">Request</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">consumes:</div><div
class="mono">application/x-www-form-urlencoded</div><div
class="clear"></div></div>
+
+ </div>
+
+
+
+ <div class="title">Response</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">produces:</div><div
class="mono">text/plain</div><div class="clear"></div></div>
+
+ </div>
+ <table>
+ <thead>
+ <tr>
+ <th>Status Code</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>200</td>
+ <td>
+
+
+
+ </td>
+ <td>successful operation</td>
+ </tr>
+
+ <tr>
+ <td>403</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Client is not authorized to make this request.</td>
+ </tr>
+
+ <tr>
+ <td>409</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Unable to create the download token because NiFi is not in
the appropriate state. (i.e. may not have any tokens to grant or be configured
to support username/password login)</td>
+ </tr>
+
+ <tr>
+ <td>500</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Unable to create download token because an unexpected
error occurred.</td>
+ </tr>
+
+ </tbody>
</table>
<div class="title">Authorization</div>
<div class="authorization details">
