From af74a6270d6ab6badf04a97495a6ef8ccded9b4b Mon Sep 17 00:00:00 2001
From: ramverma <ram.krishna.verma@ericsson.com>
Date: Tue, 31 Jul 2018 18:25:39 +0100
Subject: Adding first set of apex-pdp document changes

Adding document changes for auth, context, core, model, services & the
main apex-pdp module.

Change-Id: Id0d026baa258f1dc6998978f9911f3c4a73b5b3b
Issue-ID: POLICY-867
Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>
---
 .../adoc/fragments/config-general-format.adoc      | 65 ++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 services/services-engine/src/site-docs/adoc/fragments/config-general-format.adoc

(limited to 'services/services-engine/src/site-docs/adoc/fragments/config-general-format.adoc')

diff --git a/services/services-engine/src/site-docs/adoc/fragments/config-general-format.adoc b/services/services-engine/src/site-docs/adoc/fragments/config-general-format.adoc
new file mode 100644
index 000000000..27e076701
--- /dev/null
+++ b/services/services-engine/src/site-docs/adoc/fragments/config-general-format.adoc
@@ -0,0 +1,65 @@
+//
+// ============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)
+//
+
+== General Configuration Format
+
+The APEX configuration file is a JSON file containing a few main blocks for different parts of the configuration.
+Each block then holds the configuration details.
+The following code shows the main blocks:
+
+[source%nowrap,json]
+----
+{
+  "engineServiceParameters":{
+    ... // <1>
+    "engineParameters":{ <2>
+      "engineParameters":{...}, <3>
+      "contextParameters":{...} <4>
+    }
+  },
+  "eventInputParameters":{ <5>
+    "input1":{ <6>
+      "carrierTechnologyParameters":{...},
+      "eventProtocolParameters":{...}
+    },
+    "input2":{...}, <7>
+      "carrierTechnologyParameters":{...},
+      "eventProtocolParameters":{...}
+    },
+    ... // <8>
+  },
+  "eventOutputParameters":{ <9>
+    "output1":{ <10>
+      "carrierTechnologyParameters":{...},
+      "eventProtocolParameters":{...}
+    },
+    "output2":{ <11>
+      "carrierTechnologyParameters":{...},
+      "eventProtocolParameters":{...}
+    },
+    ... // <12>
+  }
+}
+----
+<1> main engine configuration
+<2> engine parameters for plugin configurations (execution environments and context handling)
+<3> engine specific parameters, mainly for executor plugins
+<4> context specific parameters, e.g. for context schemas, persistence, etc.
+<5> configuration of the input interface
+<6> an example input called `input1` with carrier technology and event protocol
+<7> an example input called `input2` with carrier technology and event protocol
+<8> any further input configuration
+<9> configuration of the output interface
+<10> an example output called `output1` with carrier technology and event protocol
+<11> an example output called `output2` with carrier technology and event protocol
+<12> any further output configuration
-- 
cgit 1.2.3-korg