This is an automated email from the ASF dual-hosted git repository.
mcasters pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/master by this push:
new 32e493fa8a Update rest.adoc
new 7ad71844fb Merge pull request #3346 from Mattang-Dan/patch-34
32e493fa8a is described below
commit 32e493fa8af681a2f6f76d689ef8d2d64c951435
Author: Mattang-Dan <[email protected]>
AuthorDate: Thu Nov 2 12:26:14 2023 -0700
Update rest.adoc
---
.../ROOT/pages/pipeline/transforms/rest.adoc | 21 +++++++++++++--------
1 file changed, 13 insertions(+), 8 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/rest.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/rest.adoc
index a15b6c3b95..b569266bc2 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/rest.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/rest.adoc
@@ -25,9 +25,11 @@ under the License.
|
== Description
-The REST Client transform enables you to consume RESTfull services.
+The REST Client transform enables you to consume RESTfull services.
Representational State Transfer (REST) is a key design idiom that embraces a
stateless client-server architecture in which the web services are viewed as
resources and can be identified by their URLs.
+
+== Example
+The REST client Transform returns a "result" field (can change the name), and
the field is often used in the next transform. For example, it can be read in
by a JSON input transform that extracts the fields specified on the Fields tab.
-Representational State Transfer (REST) is a key design idiom that embraces a
stateless client-server architecture in which the web services are viewed as
resources and can be identified by their URLs.
|
== Supported Engines
@@ -56,7 +58,7 @@ The General tab is where you enter basic connection
information for accessing a
|HTTP method|Indicates how the transform interacts with a resource---options
are either GET, PUT, DELETE, POST, HEAD, or OPTIONS
|Get Method from field|Designates the GET method is defined from a field
|Method fieldname|Indicates the field from which the GET method is defined
-|Body field|Contains the request body for POST, PUT, and DELETE methods
+|Body field|Contains the request body for POST, PUT, and DELETE methods. Body
field only accepts a previous field, not a hard coded value.
|Application type|Designates what type of application a resource is---options
are either TEXT PLAIN, XML, JSON, OCTET STREAM, XHTML, FORM URLENCODED, ATOM
XML, SVG XML, or TEXT XML
|Result fieldname|Designates the name of the result output field
|HTTP status code fieldname|Designates the name of the HTTP status code field
@@ -67,6 +69,8 @@ The General tab is where you enter basic connection
information for accessing a
If necessary, enter authentication details for a resource in the
Authentication tab.
+TIP: Hop allows using NULL parameters/variables for both the HTTP Login and
HTTP Password.
+
[options="header"]
|===
|Option|Description
@@ -90,14 +94,15 @@ The SSL tab is where you provide authentication details for
accessing a resource
=== Headers Tab
-The Headers tab enables you to define the content of any HTTP headers using an
existing field.
-Populate the list of fields by clicking the Get fields button.
+The Headers tab enables you to define the content of any HTTP headers using an
existing field. Populate the list of fields by clicking the Get fields button.
+
+TIP: To figure out what Headers are required, you can use Postman and remove
as many headers as possible for the Request to still work. You should not need
to use the Headers with value “<calculated when request is sent>” in Postman.
You do not need to manually add an Authorization header if you used the
Authentication tab.
[options="header"]
|===
|Option|Description
-|Field|The field from incoming Hop stream that contains the header information
-|Name|The name of the outgoing Hop field from this transform
+|Field|The field from incoming Hop stream that contains the header
information. Add the header value field name to the Field column.
+|Name|The name of the outgoing Hop field from this transform. Add the header
key field name to the Name column.
|===
=== Parameters Tab
@@ -121,4 +126,4 @@ Use the Matrix Parameters tab to define matrix parameter
values for POST, PUT, D
|Option|Description
|Parameter|The field from the incoming Hop stream that contains the matrix
parameter information
|Parameter|The name of the outgoing Hop field from this transform
-|===
\ No newline at end of file
+|===
