summaryrefslogtreecommitdiffstats
path: root/ahl-binding/ahl-apidef.h
diff options
context:
space:
mode:
authorFulup Ar Foll <fulup@iot.bzh>2017-11-05 13:01:07 +0100
committerFulup Ar Foll <fulup@iot.bzh>2017-11-05 13:01:07 +0100
commit2e2cf0b8f97c8a72255ab0b977f94bd6c684b203 (patch)
tree79300297cb13c7be472663841be1ffd9e8177e04 /ahl-binding/ahl-apidef.h
parent68f1187061c28ecf6439b4dd465f4d256529dc55 (diff)
Added few protection again invalid config
Diffstat (limited to 'ahl-binding/ahl-apidef.h')
-rw-r--r--ahl-binding/ahl-apidef.h222
1 files changed, 111 insertions, 111 deletions
diff --git a/ahl-binding/ahl-apidef.h b/ahl-binding/ahl-apidef.h
index 2c77827..a9cb6dd 100644
--- a/ahl-binding/ahl-apidef.h
+++ b/ahl-binding/ahl-apidef.h
@@ -4,118 +4,118 @@ static const char _afb_description_v2_ahl_4a[] =
"for AGL applications\",\"title\":\"audiohighlevel\",\"version\":\"1.0\","
"\"x-binding-c-generator\":{\"api\":\"ahl-4a\",\"version\":2,\"prefix\":\""
"audiohlapi_\",\"postfix\":\"\",\"start\":null,\"onevent\":\"AhlOnEvent\""
- ",\"init\":\"AhlBindingInit\",\"scope\":\"\",\"private\":false}},\"server"
- "s\":[{\"url\":\"ws://{host}:{port}/api/audiohl\",\"description\":\"Audio"
- " high level API for AGL applications.\",\"variables\":{\"host\":{\"defau"
- "lt\":\"localhost\"},\"port\":{\"default\":\"1234\"}},\"x-afb-events\":[{"
- "\"$ref\":\"#/components/schemas/afb-event\"}]}],\"components\":{\"schema"
- "s\":{\"afb-reply\":{\"$ref\":\"#/components/schemas/afb-reply-v2\"},\"af"
- "b-event\":{\"$ref\":\"#/components/schemas/afb-event-v2\"},\"afb-reply-v"
- "2\":{\"title\":\"Generic response.\",\"type\":\"object\",\"required\":[\""
- "jtype\",\"request\"],\"properties\":{\"jtype\":{\"type\":\"string\",\"co"
- "nst\":\"afb-reply\"},\"request\":{\"type\":\"object\",\"required\":[\"st"
- "atus\"],\"properties\":{\"status\":{\"type\":\"string\"},\"info\":{\"typ"
- "e\":\"string\"},\"token\":{\"type\":\"string\"},\"uuid\":{\"type\":\"str"
- "ing\"},\"reqid\":{\"type\":\"string\"}}},\"response\":{\"type\":\"object"
- "\"}}},\"afb-event-v2\":{\"type\":\"object\",\"required\":[\"jtype\",\"ev"
- "ent\"],\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-ev"
- "ent\"},\"event\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}},"
- "\"endpoint_info\":{\"type\":\"object\",\"required\":[\"endpoint_id\",\"t"
- "ype\",\"device_name\",\"device_uri\"],\"properties\":{\"endpoint_id\":{\""
- "type\":\"int\"},\"type\":{\"type\":\"enum\"},\"device_name\":{\"type\":\""
- "string\"},\"device_uri_type\":{\"type\":\"string\"}}},\"stream_info\":{\""
- "type\":\"object\",\"required\":[\"stream_id\",\"state\",\"mute\",\"endpo"
- "int_info\"],\"properties\":{\"stream_id\":{\"type\":\"int\"},\"state\":{"
- "\"type\":\"int\"},\"mute\":{\"type\":\"int\"},\"device_uri\":{\"type\":\""
- "string\"},\"$ref\":\"#/components/schemas/endpoint_info\"}}},\"x-permiss"
- "ions\":{\"streamcontrol\":{\"permission\":\"urn:AGL:permission:audio:pub"
- "lic:streamcontrol\"},\"endpointcontrol\":{\"permission\":\"urn:AGL:permi"
- "ssion:audio:public:endpointcontrol\"},\"audiostream\":{\"permission\":\""
- "urn:AGL:permission:audio:public:audiostream\"},\"soundevent\":{\"permiss"
- "ion\":\"urn:AGL:permission:audio:public:soundevent\"}},\"responses\":{\""
- "200\":{\"description\":\"A complex object array response\",\"content\":{"
- "\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/afb-re"
- "ply\"}}}},\"400\":{\"description\":\"Invalid arguments\"}}},\"paths\":{\""
- "/get_endpoints\":{\"description\":\"Retrieve array of available audio en"
- "dpoints\",\"get\":{\"parameters\":[{\"in\":\"query\",\"name\":\"audio_ro"
- "le\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"in\":\"query"
- "\",\"name\":\"endpoint_type\",\"required\":true,\"schema\":{\"type\":\"e"
- "num\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\""
- ",\"response\":{\"description\":\"Array of endpoint info structures\",\"t"
- "ype\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/endpoint_info"
- "\"}}},\"400\":{\"$ref\":\"#/components/responses/400\"}}}},\"/stream_ope"
- "n\":{\"description\":\"Request opening a stream\",\"get\":{\"x-permissio"
- "ns\":{\"$ref\":\"#/components/x-permissions/audiostream\"},\"parameters\""
- ":[{\"in\":\"query\",\"name\":\"audio_role\",\"required\":true,\"schema\""
- ":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"endpoint_type\",\"r"
- "equired\":true,\"schema\":{\"type\":\"enum\"}},{\"in\":\"query\",\"name\""
- ":\"endpoint_id\",\"required\":false,\"schema\":{\"type\":\"int\"}}],\"re"
- "sponses\":{\"200\":{\"$ref\":\"#/components/responses/200\",\"response\""
- ":{\"description\":\"Stream information structure\",\"$ref\":\"#/componen"
- "ts/schemas/stream_info\"}},\"400\":{\"$ref\":\"#/components/responses/40"
- "0\"}}}},\"/stream_close\":{\"description\":\"Request closing a stream\","
- "\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/audios"
- "tream\"},\"parameters\":[{\"in\":\"query\",\"name\":\"stream_id\",\"requ"
- "ired\":false,\"schema\":{\"type\":\"int\"}}],\"responses\":{\"200\":{\"$"
- "ref\":\"#/components/responses/200\"},\"400\":{\"$ref\":\"#/components/r"
- "esponses/400\"}}}},\"/set_stream_state\":{\"description\":\"Change strea"
- "m active and/or mute state\",\"get\":{\"x-permissions\":{\"$ref\":\"#/co"
- "mponents/x-permissions/streamcontrol\"},\"parameters\":[{\"in\":\"query\""
- ",\"name\":\"stream_id\",\"required\":false,\"schema\":{\"type\":\"int\"}"
- "},{\"in\":\"query\",\"name\":\"state\",\"required\":false,\"schema\":{\""
- "type\":\"int\"}},{\"in\":\"query\",\"name\":\"mute\",\"required\":false,"
- "\"schema\":{\"type\":\"int\"}}],\"responses\":{\"200\":{\"$ref\":\"#/com"
- "ponents/responses/200\"},\"400\":{\"$ref\":\"#/components/responses/400\""
- "}}}},\"/get_stream_info\":{\"description\":\"Retrieve stream information"
- "\",\"get\":{\"parameters\":[{\"in\":\"query\",\"name\":\"stream_id\",\"r"
- "equired\":true,\"schema\":{\"type\":\"int\"}}],\"responses\":{\"200\":{\""
- "$ref\":\"#/components/responses/200\",\"response\":{\"description\":\"St"
- "ream information structure\",\"$ref\":\"#/components/schemas/stream_info"
- "\"}},\"400\":{\"$ref\":\"#/components/responses/400\"}}}},\"/volume\":{\""
- "description\":\"Set or get volume on endpoint\",\"get\":{\"x-permissions"
- "\":{\"$ref\":\"#/components/x-permissions/endpointcontrol\"},\"parameter"
- "s\":[{\"in\":\"query\",\"name\":\"endpoint_type\",\"required\":true,\"sc"
- "hema\":{\"type\":\"enum\"}},{\"in\":\"query\",\"name\":\"endpoint_id\",\""
- "required\":true,\"schema\":{\"type\":\"int\"}},{\"in\":\"query\",\"name\""
- ":\"volume\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"resp"
- "onses\":{\"200\":{\"$ref\":\"#/components/responses/200\"},\"400\":{\"$r"
- "ef\":\"#/components/responses/400\"}}}},\"/get_endpoint_info\":{\"descri"
- "ption\":\"Retrieve endpoint information including its properties\",\"get"
- "\":{\"parameters\":[{\"in\":\"query\",\"name\":\"endpoint_type\",\"requi"
+ ",\"init\":\"AhlBindingInit\",\"scope\":\"\",\"private\":false,\"noconcur"
+ "rency\":false}},\"servers\":[{\"url\":\"ws://{host}:{port}/api/audiohl\""
+ ",\"description\":\"Audio high level API for AGL applications.\",\"variab"
+ "les\":{\"host\":{\"default\":\"localhost\"},\"port\":{\"default\":\"1234"
+ "\"}},\"x-afb-events\":[{\"$ref\":\"#/components/schemas/afb-event\"}]}],"
+ "\"components\":{\"schemas\":{\"afb-reply\":{\"$ref\":\"#/components/sche"
+ "mas/afb-reply-v2\"},\"afb-event\":{\"$ref\":\"#/components/schemas/afb-e"
+ "vent-v2\"},\"afb-reply-v2\":{\"title\":\"Generic response.\",\"type\":\""
+ "object\",\"required\":[\"jtype\",\"request\"],\"properties\":{\"jtype\":"
+ "{\"type\":\"string\",\"const\":\"afb-reply\"},\"request\":{\"type\":\"ob"
+ "ject\",\"required\":[\"status\"],\"properties\":{\"status\":{\"type\":\""
+ "string\"},\"info\":{\"type\":\"string\"},\"token\":{\"type\":\"string\"}"
+ ",\"uuid\":{\"type\":\"string\"},\"reqid\":{\"type\":\"string\"}}},\"resp"
+ "onse\":{\"type\":\"object\"}}},\"afb-event-v2\":{\"type\":\"object\",\"r"
+ "equired\":[\"jtype\",\"event\"],\"properties\":{\"jtype\":{\"type\":\"st"
+ "ring\",\"const\":\"afb-event\"},\"event\":{\"type\":\"string\"},\"data\""
+ ":{\"type\":\"object\"}}},\"endpoint_info\":{\"type\":\"object\",\"requir"
+ "ed\":[\"endpoint_id\",\"type\",\"device_name\",\"device_uri\"],\"propert"
+ "ies\":{\"endpoint_id\":{\"type\":\"int\"},\"type\":{\"type\":\"enum\"},\""
+ "device_name\":{\"type\":\"string\"},\"device_uri_type\":{\"type\":\"stri"
+ "ng\"}}},\"stream_info\":{\"type\":\"object\",\"required\":[\"stream_id\""
+ ",\"state\",\"mute\",\"endpoint_info\"],\"properties\":{\"stream_id\":{\""
+ "type\":\"int\"},\"state\":{\"type\":\"int\"},\"mute\":{\"type\":\"int\"}"
+ ",\"device_uri\":{\"type\":\"string\"},\"$ref\":\"#/components/schemas/en"
+ "dpoint_info\"}}},\"x-permissions\":{\"streamcontrol\":{\"permission\":\""
+ "urn:AGL:permission:audio:public:streamcontrol\"},\"endpointcontrol\":{\""
+ "permission\":\"urn:AGL:permission:audio:public:endpointcontrol\"},\"audi"
+ "ostream\":{\"permission\":\"urn:AGL:permission:audio:public:audiostream\""
+ "},\"soundevent\":{\"permission\":\"urn:AGL:permission:audio:public:sound"
+ "event\"}},\"responses\":{\"200\":{\"description\":\"A complex object arr"
+ "ay response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\""
+ "#/components/schemas/afb-reply\"}}}},\"400\":{\"description\":\"Invalid "
+ "arguments\"}}},\"paths\":{\"/get_endpoints\":{\"description\":\"Retrieve"
+ " array of available audio endpoints\",\"get\":{\"parameters\":[{\"in\":\""
+ "query\",\"name\":\"audio_role\",\"required\":true,\"schema\":{\"type\":\""
+ "string\"}},{\"in\":\"query\",\"name\":\"endpoint_type\",\"required\":tru"
+ "e,\"schema\":{\"type\":\"enum\"}}],\"responses\":{\"200\":{\"$ref\":\"#/"
+ "components/responses/200\",\"response\":{\"description\":\"Array of endp"
+ "oint info structures\",\"type\":\"array\",\"items\":{\"$ref\":\"#/compon"
+ "ents/schemas/endpoint_info\"}}},\"400\":{\"$ref\":\"#/components/respons"
+ "es/400\"}}}},\"/stream_open\":{\"description\":\"Request opening a strea"
+ "m\",\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/au"
+ "diostream\"},\"parameters\":[{\"in\":\"query\",\"name\":\"audio_role\",\""
+ "required\":true,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"na"
+ "me\":\"endpoint_type\",\"required\":true,\"schema\":{\"type\":\"enum\"}}"
+ ",{\"in\":\"query\",\"name\":\"endpoint_id\",\"required\":false,\"schema\""
+ ":{\"type\":\"int\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/re"
+ "sponses/200\",\"response\":{\"description\":\"Stream information structu"
+ "re\",\"$ref\":\"#/components/schemas/stream_info\"}},\"400\":{\"$ref\":\""
+ "#/components/responses/400\"}}}},\"/stream_close\":{\"description\":\"Re"
+ "quest closing a stream\",\"get\":{\"x-permissions\":{\"$ref\":\"#/compon"
+ "ents/x-permissions/audiostream\"},\"parameters\":[{\"in\":\"query\",\"na"
+ "me\":\"stream_id\",\"required\":false,\"schema\":{\"type\":\"int\"}}],\""
+ "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"},\"400\":{"
+ "\"$ref\":\"#/components/responses/400\"}}}},\"/set_stream_state\":{\"des"
+ "cription\":\"Change stream active and/or mute state\",\"get\":{\"x-permi"
+ "ssions\":{\"$ref\":\"#/components/x-permissions/streamcontrol\"},\"param"
+ "eters\":[{\"in\":\"query\",\"name\":\"stream_id\",\"required\":false,\"s"
+ "chema\":{\"type\":\"int\"}},{\"in\":\"query\",\"name\":\"state\",\"requi"
+ "red\":false,\"schema\":{\"type\":\"int\"}},{\"in\":\"query\",\"name\":\""
+ "mute\",\"required\":false,\"schema\":{\"type\":\"int\"}}],\"responses\":"
+ "{\"200\":{\"$ref\":\"#/components/responses/200\"},\"400\":{\"$ref\":\"#"
+ "/components/responses/400\"}}}},\"/get_stream_info\":{\"description\":\""
+ "Retrieve stream information\",\"get\":{\"parameters\":[{\"in\":\"query\""
+ ",\"name\":\"stream_id\",\"required\":true,\"schema\":{\"type\":\"int\"}}"
+ "],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\",\"resp"
+ "onse\":{\"description\":\"Stream information structure\",\"$ref\":\"#/co"
+ "mponents/schemas/stream_info\"}},\"400\":{\"$ref\":\"#/components/respon"
+ "ses/400\"}}}},\"/volume\":{\"description\":\"Set or get volume on endpoi"
+ "nt\",\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/e"
+ "ndpointcontrol\"},\"parameters\":[{\"in\":\"query\",\"name\":\"endpoint_"
+ "type\",\"required\":true,\"schema\":{\"type\":\"enum\"}},{\"in\":\"query"
+ "\",\"name\":\"endpoint_id\",\"required\":true,\"schema\":{\"type\":\"int"
+ "\"}},{\"in\":\"query\",\"name\":\"volume\",\"required\":false,\"schema\""
+ ":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components"
+ "/responses/200\"},\"400\":{\"$ref\":\"#/components/responses/400\"}}}},\""
+ "/get_endpoint_info\":{\"description\":\"Retrieve endpoint information in"
+ "cluding its properties\",\"get\":{\"parameters\":[{\"in\":\"query\",\"na"
+ "me\":\"endpoint_type\",\"required\":true,\"schema\":{\"type\":\"enum\"}}"
+ ",{\"in\":\"query\",\"name\":\"endpoint_id\",\"required\":true,\"schema\""
+ ":{\"type\":\"int\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/re"
+ "sponses/200\"},\"400\":{\"$ref\":\"#/components/responses/400\"}}}},\"/p"
+ "roperty\":{\"description\":\"Set/get endpoint property value\",\"get\":{"
+ "\"x-permissions\":{\"$ref\":\"#/components/x-permissions/endpointcontrol"
+ "\"},\"parameters\":[{\"in\":\"query\",\"name\":\"endpoint_type\",\"requi"
"red\":true,\"schema\":{\"type\":\"enum\"}},{\"in\":\"query\",\"name\":\""
- "endpoint_id\",\"required\":true,\"schema\":{\"type\":\"int\"}}],\"respon"
- "ses\":{\"200\":{\"$ref\":\"#/components/responses/200\"},\"400\":{\"$ref"
- "\":\"#/components/responses/400\"}}}},\"/property\":{\"description\":\"S"
- "et/get endpoint property value\",\"get\":{\"x-permissions\":{\"$ref\":\""
- "#/components/x-permissions/endpointcontrol\"},\"parameters\":[{\"in\":\""
- "query\",\"name\":\"endpoint_type\",\"required\":true,\"schema\":{\"type\""
- ":\"enum\"}},{\"in\":\"query\",\"name\":\"endpoint_id\",\"required\":true"
- ",\"schema\":{\"type\":\"int\"}},{\"in\":\"query\",\"name\":\"property_na"
- "me\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"in\":\"query"
- "\",\"name\":\"value\",\"required\":false,\"schema\":{\"type\":\"string\""
- "}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"},\"4"
- "00\":{\"$ref\":\"#/components/responses/400\"}}}},\"/get_list_actions\":"
- "{\"description\":\"Retrieve a list of supported actions for a particular"
- " audio role\",\"get\":{\"parameters\":[{\"in\":\"query\",\"name\":\"audi"
- "o_role\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"response"
- "s\":{\"200\":{\"$ref\":\"#/components/responses/200\"},\"400\":{\"$ref\""
- ":\"#/components/responses/400\"}}}},\"/post_action\":{\"description\":\""
- "Post sound or audio device related action event (extendable mechanism)\""
- ",\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/sound"
- "event\"},\"parameters\":[{\"in\":\"query\",\"name\":\"action_name\",\"re"
- "quired\":true,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name"
- "\":\"audio_role\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\""
- "in\":\"query\",\"name\":\"media_name\",\"required\":false,\"schema\":{\""
- "type\":\"string\"}},{\"in\":\"query\",\"name\":\"action_context\",\"requ"
- "ired\":false,\"schema\":{\"type\":\"object\"}}],\"responses\":{\"200\":{"
- "\"$ref\":\"#/components/responses/200\"},\"400\":{\"$ref\":\"#/component"
- "s/responses/400\"}}}},\"/event_subscription\":{\"description\":\"Subscri"
- "be to audio high level events\",\"get\":{\"parameters\":[{\"in\":\"query"
- "\",\"name\":\"events\",\"required\":true,\"schema\":{\"type\":\"array\","
- "\"items\":{\"type\":\"string\"}}},{\"in\":\"query\",\"name\":\"subscribe"
- "\",\"required\":true,\"schema\":{\"type\":\"int\"}}],\"responses\":{\"20"
- "0\":{\"$ref\":\"#/components/responses/200\"},\"400\":{\"$ref\":\"#/comp"
- "onents/responses/400\"}}}}}}"
+ "endpoint_id\",\"required\":true,\"schema\":{\"type\":\"int\"}},{\"in\":\""
+ "query\",\"name\":\"property_name\",\"required\":true,\"schema\":{\"type\""
+ ":\"string\"}},{\"in\":\"query\",\"name\":\"value\",\"required\":false,\""
+ "schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/co"
+ "mponents/responses/200\"},\"400\":{\"$ref\":\"#/components/responses/400"
+ "\"}}}},\"/get_list_actions\":{\"description\":\"Retrieve a list of suppo"
+ "rted actions for a particular audio role\",\"get\":{\"parameters\":[{\"i"
+ "n\":\"query\",\"name\":\"audio_role\",\"required\":true,\"schema\":{\"ty"
+ "pe\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/respo"
+ "nses/200\"},\"400\":{\"$ref\":\"#/components/responses/400\"}}}},\"/post"
+ "_action\":{\"description\":\"Post sound or audio device related action e"
+ "vent (extendable mechanism)\",\"get\":{\"x-permissions\":{\"$ref\":\"#/c"
+ "omponents/x-permissions/soundevent\"},\"parameters\":[{\"in\":\"query\","
+ "\"name\":\"action_name\",\"required\":true,\"schema\":{\"type\":\"string"
+ "\"}},{\"in\":\"query\",\"name\":\"audio_role\",\"required\":true,\"schem"
+ "a\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"media_name\",\"r"
+ "equired\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"na"
+ "me\":\"action_context\",\"required\":false,\"schema\":{\"type\":\"object"
+ "\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"},\""
+ "400\":{\"$ref\":\"#/components/responses/400\"}}}},\"/event_subscription"
+ "\":{\"description\":\"Subscribe to audio high level events\",\"get\":{\""
+ "parameters\":[{\"in\":\"query\",\"name\":\"events\",\"required\":true,\""
+ "schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},{\"in\":\""
+ "query\",\"name\":\"subscribe\",\"required\":true,\"schema\":{\"type\":\""
+ "int\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\""
+ "},\"400\":{\"$ref\":\"#/components/responses/400\"}}}}}}"
;
static const struct afb_auth _afb_auths_v2_ahl_4a[] = {