From 99fb10ecca6b1679c1fe402508216c0f82140ef5 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 16 Sep 2016 18:47:57 +0200 Subject: Improvement of the documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I8f220d7508d939a16eba956ab1fdf975f4048332 Signed-off-by: José Bollo --- doc/afb-application-writing.html | 56 ++++++++++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 19 deletions(-) (limited to 'doc/afb-application-writing.html') diff --git a/doc/afb-application-writing.html b/doc/afb-application-writing.html index 12a2f13f..9d051d5e 100644 --- a/doc/afb-application-writing.html +++ b/doc/afb-application-writing.html @@ -8,29 +8,47 @@ HOWTO WRITE an APPLICATION above AGL FRAMEWORK - +
@@ -184,7 +202,7 @@ ON-REPLY 1:auth/check: {"jtype":"afb-reply","request&qu

This object contains at least 2 mandatory fields of name jtype and request and one optional field of name response.

Template

This is a template of replies:

-
{
+
{
    "jtype": "afb-reply",
    "request": {
       "status": "success",
@@ -194,7 +212,7 @@ ON-REPLY 1:auth/check: {"jtype":"afb-reply","request&qu
       "reqid": "application-generated-id-23456"
    },
    "response": ....any response object....
-}

+}

Field jtype

The field jtype must have a value of type string equal to "afb-reply".

Field request

@@ -216,11 +234,11 @@ ON-REPLY 1:auth/check: {"jtype":"afb-reply","request&qu

This object contains at least 2 mandatory fields of name jtype and event and one optional field of name data.

Template

Here is a template of event:

-
{
+
{
    "jtype": "afb-event",
    "event": "sample_api_name/sample_event_name",
    "data": ...any event data...
-}

+}

Field jtype

The field jtype must have a value of type string equal to "afb-event".

Field event

-- cgit 1.2.3-korg