summaryrefslogtreecommitdiffstats
path: root/src/vshl-core-apidef.h
diff options
context:
space:
mode:
authorNaveen Bobbili <nbobbili@amazon.com>2019-02-25 17:24:29 -0800
committerNaveen Bobbili <nbobbili@amazon.com>2019-02-25 20:55:05 -0800
commit9eb3a90df3681586b58146b47eea7f3848c348a0 (patch)
tree9c507e13c233fb649d04c6a45d152f7ec12185f8 /src/vshl-core-apidef.h
parent143363b9e864ea465c927057ce7214f124a984cb (diff)
Refactored VSHL into vshl-core and vshl-capabilities.
vshl-core: This API is responsible for request arbitration. Verbs exposed are 1. startListening 2. cancelListening 3. subscribe 4. enumerateVoiceAgents 5. setDefaultVoiceAgent Used by applications to subscribe to dialog, connection and auth states of underlying low level voiceagent bindings. Used by applications to trigger voice recognition routine of the underlying low level voiceagent binding. vshl-capabilities: This API exposes publish and subscribe methods for all the speech framework domains/capabilities. For eg. navigation, phonecontrol etc. This API is used by apps and low level voice agent binding to subscribe and publish these capability messages whenever applicable. The code for this is agl-service-voice-high-capabilities repository. This specific commit is for vshl-core API. Change-Id: I1101db19b57ee918482a178843641b088508ac5d Signed-off-by: Naveen Bobbili <nbobbili@amazon.com>
Diffstat (limited to 'src/vshl-core-apidef.h')
-rw-r--r--src/vshl-core-apidef.h52
1 files changed, 52 insertions, 0 deletions
diff --git a/src/vshl-core-apidef.h b/src/vshl-core-apidef.h
new file mode 100644
index 0000000..93d880e
--- /dev/null
+++ b/src/vshl-core-apidef.h
@@ -0,0 +1,52 @@
+
+static const char _afb_description_vshl_core[] =
+ "{\"openapi\":\"3.0.0\",\"$schema\":\"http://iot.bzh/download/openapi/sch"
+ "ema-3.0/default-schema.json\",\"info\":{\"description\":\"\",\"title\":\""
+ "High Level Voice Service Core API\",\"version\":\"1.0\",\"x-binding-c-ge"
+ "nerator\":{\"api\":\"vshl-core\",\"version\":3,\"prefix\":\"afv_\",\"pos"
+ "tfix\":\"\",\"start\":null,\"onevent\":null,\"init\":\"init\",\"scope\":"
+ "\"\",\"private\":false,\"noconcurrency\":true}},\"servers\":[{\"url\":\""
+ "ws://{host}:{port}/api/monitor\",\"description\":\"TS caching binding\","
+ "\"variables\":{\"host\":{\"default\":\"localhost\"},\"port\":{\"default\""
+ ":\"1234\"}},\"x-afb-events\":[{\"$ref\":\"#/components/schemas/afb-event"
+ "\"}]}],\"components\":{\"schemas\":{\"afb-reply\":{\"$ref\":\"#/componen"
+ "ts/schemas/afb-reply-v3\"},\"afb-event\":{\"$ref\":\"#/components/schema"
+ "s/afb-event-v3\"},\"afb-reply-v3\":{\"title\":\"Generic response.\",\"ty"
+ "pe\":\"object\",\"required\":[\"jtype\",\"request\"],\"properties\":{\"j"
+ "type\":{\"type\":\"string\",\"const\":\"afb-reply\"},\"request\":{\"type"
+ "\":\"object\",\"required\":[\"status\"],\"properties\":{\"status\":{\"ty"
+ "pe\":\"string\"},\"info\":{\"type\":\"string\"},\"token\":{\"type\":\"st"
+ "ring\"},\"uuid\":{\"type\":\"string\"},\"reqid\":{\"type\":\"string\"}}}"
+ ",\"response\":{\"type\":\"object\"}}},\"afb-event-v3\":{\"type\":\"objec"
+ "t\",\"required\":[\"jtype\",\"event\"],\"properties\":{\"jtype\":{\"type"
+ "\":\"string\",\"const\":\"afb-event\"},\"event\":{\"type\":\"string\"},\""
+ "data\":{\"type\":\"object\"}}}},\"responses\":{\"200\":{\"description\":"
+ "\"A complex object array response\",\"content\":{\"application/json\":{\""
+ "schema\":{\"$ref\":\"#/components/schemas/afb-reply\"}}}}}}}"
+;
+
+
+static const struct afb_verb_v3 _afb_verbs_vshl_core[] = {
+ {
+ .verb = NULL,
+ .callback = NULL,
+ .auth = NULL,
+ .info = NULL,
+ .session = 0,
+ .vcbdata = NULL,
+ .glob = 0
+ }
+};
+
+const struct afb_binding_v3 afbBindingV3 = {
+ .api = "vshl-core",
+ .specification = _afb_description_vshl_core,
+ .info = "",
+ .verbs = _afb_verbs_vshl_core,
+ .preinit = NULL,
+ .init = init,
+ .onevent = NULL,
+ .userdata = NULL,
+ .noconcurrency = 1
+};
+