X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=low-can-binding%2Fbinding%2Flow-can-apidef.h;h=a6fe7972552692168e08885a2eefb6779d11e3f1;hb=1cd79737786b8aa12bfb552bbe77f1e2301758f7;hp=d66af134fc5fdd992ef3aa417ebdbbfed16ad7bc;hpb=6faef2305955b025c3cf1cfaf17a6aa073727c24;p=apps%2Fagl-service-can-low-level.git diff --git a/low-can-binding/binding/low-can-apidef.h b/low-can-binding/binding/low-can-apidef.h index d66af134..a6fe7972 100644 --- a/low-can-binding/binding/low-can-apidef.h +++ b/low-can-binding/binding/low-can-apidef.h @@ -2,56 +2,56 @@ static const char _afb_description_v2_low_can[] = "{\"openapi\":\"3.0.0\",\"$schema\":\"http:iot.bzh/download/openapi/schem" "a-3.0/default-schema.json\",\"info\":{\"description\":\"\",\"title\":\"l" - "ow-level-can-service\",\"version\":\"4.0\",\"x-binding-c-generator\":{\"" - "api\":\"low-can\",\"version\":2,\"prefix\":\"\",\"postfix\":\"\",\"start" - "\":null,\"onevent\":null,\"init\":\"initv2\",\"scope\":\"\",\"private\":" - "false}},\"servers\":[{\"url\":\"ws://{host}:{port}/api/monitor\",\"descr" - "iption\":\"Low level CAN API.\",\"variables\":{\"host\":{\"default\":\"l" - "ocalhost\"},\"port\":{\"default\":\"1234\"}},\"x-afb-events\":[{\"$ref\"" - ":\"#/components/schemas/afb-event\"}]}],\"components\":{\"schemas\":{\"a" - "fb-reply\":{\"$ref\":\"#/components/schemas/afb-reply-v2\"},\"afb-event\"" - ":{\"$ref\":\"#/components/schemas/afb-event-v2\"},\"afb-reply-v2\":{\"ti" - "tle\":\"Generic response.\",\"type\":\"object\",\"required\":[\"jtype\"," - "\"request\"],\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"" - "afb-reply\"},\"request\":{\"type\":\"object\",\"required\":[\"status\"]," - "\"properties\":{\"status\":{\"type\":\"string\"},\"info\":{\"type\":\"st" - "ring\"},\"token\":{\"type\":\"string\"},\"uuid\":{\"type\":\"string\"},\"" - "reqid\":{\"type\":\"string\"}}},\"response\":{\"type\":\"object\"}}},\"a" - "fb-event-v2\":{\"type\":\"object\",\"required\":[\"jtype\",\"event\"],\"" - "properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-event\"},\"" - "event\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}}},\"x-perm" - "issions\":{\"monitor\":{\"permission\":\"urn:AGL:permission:low-can:publ" - "ic:monitor\"},\"write\":{\"permission\":\"urn:AGL:permission::platform:c" - "an:write \"}},\"responses\":{\"200\":{\"description\":\"A complex object" - " array response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\"" - ":\"#/components/schemas/afb-reply\"}}}}}},\"paths\":{\"/subscribe\":{\"d" - "escription\":\"Subscribe to CAN signals events\",\"parameters\":[{\"in\"" - ":\"query\",\"name\":\"event\",\"required\":false,\"schema\":{\"type\":\"" - "string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/20" - "0\"}}},\"/unsubscribe\":{\"description\":\"Unsubscribe previously suscri" - "bed signals.\",\"parameters\":[{\"in\":\"query\",\"name\":\"event\",\"re" - "quired\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\"" - ":{\"$ref\":\"#/components/responses/200\"}}},\"/get\":{\"description\":\"" - "get a current value of CAN message\",\"parameters\":[{\"in\":\"query\",\"" + "ow-can\",\"version\":\"4.0\",\"x-binding-c-generator\":{\"api\":\"low-ca" + "n\",\"version\":2,\"prefix\":\"\",\"postfix\":\"\",\"start\":null,\"onev" + "ent\":null,\"init\":\"initv2\",\"scope\":\"\",\"private\":false}},\"serv" + "ers\":[{\"url\":\"ws://{host}:{port}/api/monitor\",\"description\":\"Low" + " level CAN API.\",\"variables\":{\"host\":{\"default\":\"localhost\"},\"" + "port\":{\"default\":\"1234\"}},\"x-afb-events\":[{\"$ref\":\"#/component" + "s/schemas/afb-event\"}]}],\"components\":{\"schemas\":{\"afb-reply\":{\"" + "$ref\":\"#/components/schemas/afb-reply-v2\"},\"afb-event\":{\"$ref\":\"" + "#/components/schemas/afb-event-v2\"},\"afb-reply-v2\":{\"title\":\"Gener" + "ic response.\",\"type\":\"object\",\"required\":[\"jtype\",\"request\"]," + "\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-reply\"}," + "\"request\":{\"type\":\"object\",\"required\":[\"status\"],\"properties\"" + ":{\"status\":{\"type\":\"string\"},\"info\":{\"type\":\"string\"},\"toke" + "n\":{\"type\":\"string\"},\"uuid\":{\"type\":\"string\"},\"reqid\":{\"ty" + "pe\":\"string\"}}},\"response\":{\"type\":\"object\"}}},\"afb-event-v2\"" + ":{\"type\":\"object\",\"required\":[\"jtype\",\"event\"],\"properties\":" + "{\"jtype\":{\"type\":\"string\",\"const\":\"afb-event\"},\"event\":{\"ty" + "pe\":\"string\"},\"data\":{\"type\":\"object\"}}}},\"x-permissions\":{\"" + "monitor\":{\"permission\":\"urn:AGL:permission:low-can:public:monitor\"}" + ",\"write\":{\"permission\":\"urn:AGL:permission::platform:can:write \"}}" + ",\"responses\":{\"200\":{\"description\":\"A complex object array respon" + "se\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/compone" + "nts/schemas/afb-reply\"}}}}}},\"paths\":{\"/subscribe\":{\"description\"" + ":\"Subscribe to CAN signals events\",\"parameters\":[{\"in\":\"query\",\"" "name\":\"event\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"" - "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/list" - "\":{\"description\":\"get a supported CAN message list\",\"responses\":{" - "\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/auth\":{\"descrip" - "tion\":\"Authenticate session to be raise Level Of Assurance.\",\"get\":" - "{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/write\"},\"res" - "ponses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/write\"" - ":{\"description\":\"Write a CAN messages to the CAN bus.\",\"get\":{\"x-" - "permissions\":{\"LOA\":1},\"parameters\":[{\"in\":\"query\",\"name\":\"b" - "us_name\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"" - "query\",\"name\":\"frame\",\"required\":false,\"schema\":{\"type\":\"arr" - "ay\"},\"parameters\":[{\"in\":\"query\",\"name\":\"can_id\",\"required\"" - ":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"ca" - "n_dlc\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"q" - "uery\",\"name\":\"can_data\",\"required\":false,\"schema\":{\"type\":\"s" - "tring\"}}]},{\"in\":\"query\",\"name\":\"signal_name\",\"required\":fals" - "e,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"signal_" - "value\",\"required\":false,\"schema\":{\"type\":\"integer\"}}],\"respons" - "es\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}}}}" + "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/unsu" + "bscribe\":{\"description\":\"Unsubscribe previously suscribed signals.\"" + ",\"parameters\":[{\"in\":\"query\",\"name\":\"event\",\"required\":false" + ",\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#" + "/components/responses/200\"}}},\"/get\":{\"description\":\"get a current" + " value of CAN message\",\"parameters\":[{\"in\":\"query\",\"name\":\"eve" + "nt\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\"" + ":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/list\":{\"descr" + "iption\":\"get a supported CAN message list\",\"responses\":{\"200\":{\"" + "$ref\":\"#/components/responses/200\"}}},\"/auth\":{\"description\":\"Au" + "thenticate session to be raise Level Of Assurance.\",\"get\":{\"x-permis" + "sions\":{\"$ref\":\"#/components/x-permissions/write\"},\"responses\":{\"" + "200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/write\":{\"descrip" + "tion\":\"Write a CAN messages to the CAN bus.\",\"get\":{\"x-permissions" + "\":{\"LOA\":1},\"parameters\":[{\"in\":\"query\",\"name\":\"bus_name\",\"" + "required\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"n" + "ame\":\"frame\",\"required\":false,\"schema\":{\"type\":\"array\"},\"par" + "ameters\":[{\"in\":\"query\",\"name\":\"can_id\",\"required\":false,\"sc" + "hema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"can_dlc\",\"r" + "equired\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"na" + "me\":\"can_data\",\"required\":false,\"schema\":{\"type\":\"string\"}}]}" + ",{\"in\":\"query\",\"name\":\"signal_name\",\"required\":false,\"schema\"" + ":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"signal_value\",\"re" + "quired\":false,\"schema\":{\"type\":\"integer\"}}],\"responses\":{\"200\"" + ":{\"$ref\":\"#/components/responses/200\"}}}}}}" ; static const struct afb_auth _afb_auths_v2_low_can[] = {