Add HTTP Target #78

odacremolbap · 2020-11-12T22:30:38Z

Add HTTP Target documentation.

closes #43

daceynolan

Sorry for the nitpicky feedback

daceynolan · 2020-11-12T23:24:21Z

docs/targets/http.md

+
+Responses from the remote endpoint will generate new [CloudEvents][ce] that will be returned to TriggerMesh. Most probably those response events should not be re-processed by the HTTP Target.
+
+It is important that the Trigger that subscribes the HTTP Target to the Broker configure the appropiate filters to avoid these loops.


Nit picky - sorry appropiate here should beappropriate

thanks
7bf9f2d

daceynolan · 2020-11-12T23:26:07Z

docs/targets/http.md

+
+| Field  | Description   | Example             |
+|---          |---            |---                  |
+| query_string | Key/value pairs formated as query string   | `name=jane&lastname=doe`  |


Nitpicky - formated here should be formatted

gracias!
7bf9f2d

cab105 · 2020-11-12T23:38:42Z

docs/targets/http.md

+- `CA Certificate`  CA certificate configured for TLS connection.
+- `Skip Verify` skips remote server TLS certificate verification.
+- `Username` when using basic authentication.
+- `Password` when using basic authentication.


Doesn't this require a secret?

it does, fixing!
thanks

ありがとうございました
9a886ca

cab105 · 2020-11-12T23:41:08Z

docs/targets/http.md

+
+## Trigger Configuration
+
+Responses from the remote endpoint will generate new [CloudEvents][ce] that will be returned to TriggerMesh. Most probably those response events should not be re-processed by the HTTP Target.


The Most probably part sounds confusing. You may need to mention to the user how to setup a trigger filter to ensure the http target doesn't end up reprocessing events.

you are right.
Most probably should be out.

I don't want to show here how to configure Triggers, we should have a generic dedicated page for that. Skipping for now and opening a follow up issue if that's ok with you.

どいたしまして！

I removed the confusing part.
634e10c

Waiting for your opinion on the trigger. I would like that one outside because transformation, infraJS, and every target that generates a response will be in the same situation. We might need a section for communication elements where we detail brokers and triggers for now, channels and subscriptions in the future.

cab105 · 2020-11-12T23:42:16Z

Would suggest perhaps a screenshot or two of the targets page, but otherwise looking good.

odacremolbap · 2020-11-12T23:44:58Z

Would suggest perhaps a screenshot or two of the targets page, but otherwise looking good.

there is a reason I'm not adding screenshots ... I hope we move secrets somewhere else, or group them with passwords and related fields.

I hope we discuss that soon.

cab105

I like what you did. Left a few more minor nits, and am approving this for when you get it taken care of.

cab105 · 2020-11-13T00:45:52Z

docs/targets/http.md

+- `Password` when using basic authentication needs to reference the aforementioned password secret.
+- `Headers` is a set of key/value pairs that will be set withing the HTTP request.
+
+Save the target, fill the rest of the bridge components and press `Submit Bridge`.


...components, and press...

cab105 · 2020-11-13T00:47:39Z

docs/targets/http.md

+- HTTP Target is interested in events whose type is `calendar.pto.request`.
+- The response from workday will generate a CloudEvent type `workday.pto.response` and source `workday.instance1`
+
+Trigger should be configured to avoid feeding these responses into the HTTP Target, a filter key `type` and value `calendar.pto.request` would provide such protection


How about:

...responses into the HTTP Target. A filter key type and value calendar.pto.request would provide such protection.

cab105 · 2020-11-13T00:48:23Z

docs/targets/http.md

+
+The HTTP Target expects a cloud event request that complements the Target configured values.
+
+There is no requirement regarding the type header value, any cloud event containing the expected data is valid to process. Data needs to be a JSON structure that might contain these optional fields:


How about "...header value. Any cloud event..."

cab105 · 2020-11-13T00:48:47Z

docs/targets/http.md

+
+
+| Field  | Description   | Example             |
+|---          |---            |---                  |


You don't need trailing spaces as mkdocs will format it correctly.

sameersbn

minor nitpicks 😛

docs/targets/http.md

sameersbn · 2020-11-13T09:39:45Z

docs/targets/http.md

+
+The HTTP event target sends requests to arbitrary URLs and wraps responses in CloudEvents back to the caller. HTTP endpoints that are unauthenticated, use basic authentication or use custom header values for authentication, can be integrated using this target.
+
+Responses from external HTTP endpoints are converted into [CloudEvents][ce] and sent as a reply to the TriggerMesh Broker/Channel. It is important that the HTTP target filters received events and cares about response event type and event source to avoid loops where those responses might end up being processed by the HTTP Target.


do we really need to link to CloudEvents page every time it;s mentioned?

probably not, I'll set it only once at the first mention and remove all other links if that's ok.

sameersbn · 2020-11-13T09:40:38Z

docs/targets/http.md

+{"body": "{\"records\":[{\"value\":{\"this\":{\"is\": \"sparta\"}}}]}"}
+```
+
+


nit: extra new-line

Co-authored-by: Sameer Naik <sameer@triggermesh.com>

sameersbn · 2020-11-13T09:51:26Z

lgtm! approved

odacremolbap self-assigned this Nov 12, 2020

odacremolbap requested review from sebgoa and cab105 November 12, 2020 22:30

add http target doc

0073a11

odacremolbap force-pushed the task/add-http-target branch from f5e6adf to 0073a11 Compare November 12, 2020 22:33

daceynolan self-requested a review November 12, 2020 23:23

daceynolan suggested changes Nov 12, 2020

View reviewed changes

fix typos

7bf9f2d

cab105 reviewed Nov 12, 2020

View reviewed changes

password field is secret

9a886ca

remove confusing 'Most probably'

634e10c

odacremolbap requested review from cab105 and daceynolan November 12, 2020 23:58

cab105 approved these changes Nov 13, 2020

View reviewed changes

typos and formatting

dbaa760

sameersbn suggested changes Nov 13, 2020

View reviewed changes

odacremolbap and others added 3 commits November 13, 2020 10:42

Update docs/targets/http.md

033e12b

Co-authored-by: Sameer Naik <sameer@triggermesh.com>

Update docs/targets/http.md

98503ac

Co-authored-by: Sameer Naik <sameer@triggermesh.com>

fix cloudevents many links, and other typos

5693292

sameersbn approved these changes Nov 13, 2020

View reviewed changes

odacremolbap merged commit 19186c9 into master Nov 13, 2020

odacremolbap deleted the task/add-http-target branch November 13, 2020 09:52

antoineco mentioned this pull request Apr 15, 2021

Add docs for all targets and sources #45

Closed

36 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HTTP Target #78

Add HTTP Target #78

odacremolbap commented Nov 12, 2020 •

edited by sebgoa

daceynolan left a comment

daceynolan Nov 12, 2020

odacremolbap Nov 12, 2020

daceynolan Nov 12, 2020

odacremolbap Nov 12, 2020

cab105 Nov 12, 2020

odacremolbap Nov 12, 2020

odacremolbap Nov 12, 2020

cab105 Nov 12, 2020

odacremolbap Nov 12, 2020

cab105 Nov 12, 2020

odacremolbap Nov 12, 2020

cab105 commented Nov 12, 2020

odacremolbap commented Nov 12, 2020

cab105 left a comment

cab105 Nov 13, 2020

odacremolbap Nov 13, 2020

cab105 Nov 13, 2020

odacremolbap Nov 13, 2020

cab105 Nov 13, 2020

odacremolbap Nov 13, 2020

cab105 Nov 13, 2020

odacremolbap Nov 13, 2020

sameersbn left a comment

sameersbn Nov 13, 2020

odacremolbap Nov 13, 2020

odacremolbap Nov 13, 2020

sameersbn Nov 13, 2020

odacremolbap Nov 13, 2020

sameersbn commented Nov 13, 2020


		Responses from the remote endpoint will generate new [CloudEvents][ce] that will be returned to TriggerMesh. Most probably those response events should not be re-processed by the HTTP Target.

		It is important that the Trigger that subscribes the HTTP Target to the Broker configure the appropiate filters to avoid these loops.


		## Trigger Configuration

		Responses from the remote endpoint will generate new [CloudEvents][ce] that will be returned to TriggerMesh. Most probably those response events should not be re-processed by the HTTP Target.


		The HTTP Target expects a cloud event request that complements the Target configured values.

		There is no requirement regarding the type header value, any cloud event containing the expected data is valid to process. Data needs to be a JSON structure that might contain these optional fields:


		The HTTP event target sends requests to arbitrary URLs and wraps responses in CloudEvents back to the caller. HTTP endpoints that are unauthenticated, use basic authentication or use custom header values for authentication, can be integrated using this target.

		Responses from external HTTP endpoints are converted into [CloudEvents][ce] and sent as a reply to the TriggerMesh Broker/Channel. It is important that the HTTP target filters received events and cares about response event type and event source to avoid loops where those responses might end up being processed by the HTTP Target.

		{"body": "{\"records\":[{\"value\":{\"this\":{\"is\": \"sparta\"}}}]}"}
		```

Add HTTP Target #78

Add HTTP Target #78

Conversation

odacremolbap commented Nov 12, 2020 • edited by sebgoa

daceynolan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cab105 commented Nov 12, 2020

odacremolbap commented Nov 12, 2020

cab105 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sameersbn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sameersbn commented Nov 13, 2020

odacremolbap commented Nov 12, 2020 •

edited by sebgoa