aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2020-10-16 13:09:11 +0100
committerliamfallon <liam.fallon@est.tech>2020-10-16 13:09:16 +0100
commit0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 (patch)
treea4fbcd97008769d55ac443bc22abf517308bf6a7 /plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient
parent9833876720ff14517ee78bda557e6021df723800 (diff)
Remove apex asciidoc documents
Apex documentation has now all been ported to use the ONAP recommended rst format. This review removes the old asciidoc documents. Issue-ID: POLICY-2824 Change-Id: I562bd344cb7d6ff36e7d54bdb8f95e3b656468f8 Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient')
-rw-r--r--plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc63
1 files changed, 0 insertions, 63 deletions
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc
deleted file mode 100644
index 64782a8bc..000000000
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc
+++ /dev/null
@@ -1,63 +0,0 @@
-//
-// ============LICENSE_START=======================================================
-// Copyright (C) 2016-2018 Ericsson. All rights reserved.
-// ================================================================================
-// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
-// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
-//
-// SPDX-License-Identifier: CC-BY-4.0
-// ============LICENSE_END=========================================================
-//
-// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
-//
-
-== REST Client IO
-
-APEX can act as REST client on the input as well as on the output interface.
-The media type is `application/json`, so this plugin does only work with the JSON Event protocol.
-
-=== REST Client Input
-
-APEX will connect to a given URL to receive events, but not send any events.
-The server is polled, i.e. APEX will do an HTTP GET, take the result, and then do the next GET.
-Any required timing needs to be handled by the server configured via the URL.
-For instance, the server could support a wait timeout via the URL as `?timeout=100ms`.
-
-[source%nowrap,json]
-----
-"carrierTechnologyParameters" : {
- "carrierTechnology" : "RESTCLIENT", <1>
- "parameterClassName" :
- "org.onap.policy.apex.plugins.event.carrier.restclient.RESTClientCarrierTechnologyParameters",
- "parameters" : {
- "url" : "http://example.org:8080/triggers/events", <2>
- }
-}
-----
-
-<1> set REST client as carrier technology
-<2> the URL of the HTTP server for events
-
-
-=== REST Client Output
-
-APEX will connect to a given URL to send events, but not receive any events.
-The default HTTP operation is POST (no configuration required).
-To change it to PUT simply add the configuration parameter (as shown in the example below).
-
-[source%nowrap,json]
-----
-"carrierTechnologyParameters" : {
- "carrierTechnology" : "RESTCLIENT", <1>
- "parameterClassName" :
- "org.onap.policy.apex.plugins.event.carrier.restclient.RESTClientCarrierTechnologyParameters",
- "parameters" : {
- "url" : "http://example.com:8888/actions/events", <2>
- "httpMethod" : "PUT" <3>
- }
-}
-----
-
-<1> set REST client as carrier technology
-<2> the URL of the HTTP server for events
-<3> use HTTP PUT (remove this line to use HTTP POST)