NIFI-1338 - Clarifying documentation for InvokeHTTP

Signed-off-by: joewitt <joewitt@apache.org>
This commit is contained in:
James Harrison 2015-12-31 14:41:01 +00:00 committed by joewitt
parent 9bb77163cf
commit 03730adb3f
1 changed files with 4 additions and 3 deletions

View File

@ -95,7 +95,8 @@ import org.joda.time.format.DateTimeFormatter;
@SupportsBatching
@Tags({"http", "https", "rest", "client"})
@InputRequirement(Requirement.INPUT_ALLOWED)
@CapabilityDescription("An HTTP client processor which converts FlowFile attributes to HTTP headers, with configurable HTTP method, url, etc.")
@CapabilityDescription("An HTTP client processor which can interact with a configurable HTTP Endpoint. The destination URL and HTTP Method are configurable."
+ " FlowFile attributes are converted to HTTP headers and the FlowFile contents are included as the body of the request (if the HTTP Method is PUT or POST).")
@WritesAttributes({
@WritesAttribute(attribute = "invokehttp.status.code", description = "The status code that is returned"),
@WritesAttribute(attribute = "invokehttp.status.message", description = "The status message that is returned"),
@ -130,8 +131,8 @@ public final class InvokeHTTP extends AbstractProcessor {
// properties
public static final PropertyDescriptor PROP_METHOD = new PropertyDescriptor.Builder()
.name("HTTP Method")
.description("HTTP request method (GET, POST, PUT, DELETE, HEAD, OPTIONS). Arbitrary methods are also supported but will "
+ "be sent without a message body.")
.description("HTTP request method (GET, POST, PUT, DELETE, HEAD, OPTIONS). Arbitrary methods are also supported. "
+ "Methods other than POST and PUT will be sent without a message body.")
.required(true)
.defaultValue("GET")
.expressionLanguageSupported(true)