low-can-binding/binding/low-can-apidef.h

   1
   2 static const char _afb_description_v2_low_can[] =
   3     "{\"openapi\":\"3.0.0\",\"$schema\":\"http:iot.bzh/download/openapi/schem"
   4     "a-3.0/default-schema.json\",\"info\":{\"description\":\"\",\"title\":\"l"
   5     "ow-level-can-service\",\"version\":\"4.0\",\"x-binding-c-generator\":{\""
   6     "api\":\"low-can\",\"version\":2,\"prefix\":\"\",\"postfix\":\"\",\"start"
   7     "\":null,\"onevent\":null,\"init\":\"initv2\",\"scope\":\"\",\"private\":"
   8     "false}},\"servers\":[{\"url\":\"ws://{host}:{port}/api/monitor\",\"descr"
   9     "iption\":\"Low level CAN API.\",\"variables\":{\"host\":{\"default\":\"l"
  10     "ocalhost\"},\"port\":{\"default\":\"1234\"}},\"x-afb-events\":[{\"$ref\""
  11     ":\"#/components/schemas/afb-event\"}]}],\"components\":{\"schemas\":{\"a"
  12     "fb-reply\":{\"$ref\":\"#/components/schemas/afb-reply-v2\"},\"afb-event\""
  13     ":{\"$ref\":\"#/components/schemas/afb-event-v2\"},\"afb-reply-v2\":{\"ti"
  14     "tle\":\"Generic response.\",\"type\":\"object\",\"required\":[\"jtype\","
  15     "\"request\"],\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\""
  16     "afb-reply\"},\"request\":{\"type\":\"object\",\"required\":[\"status\"],"
  17     "\"properties\":{\"status\":{\"type\":\"string\"},\"info\":{\"type\":\"st"
  18     "ring\"},\"token\":{\"type\":\"string\"},\"uuid\":{\"type\":\"string\"},\""
  19     "reqid\":{\"type\":\"string\"}}},\"response\":{\"type\":\"object\"}}},\"a"
  20     "fb-event-v2\":{\"type\":\"object\",\"required\":[\"jtype\",\"event\"],\""
  21     "properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-event\"},\""
  22     "event\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}}},\"x-perm"
  23     "issions\":{\"monitor\":{\"permission\":\"urn:AGL:permission:low-can:publ"
  24     "ic:monitor\"},\"write\":{\"permission\":\"urn:AGL:permission::platform:c"
  25     "an:write \"}},\"responses\":{\"200\":{\"description\":\"A complex object"
  26     " array response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\""
  27     ":\"#/components/schemas/afb-reply\"}}}}}},\"paths\":{\"/subscribe\":{\"d"
  28     "escription\":\"Subscribe to CAN signals events\",\"parameters\":[{\"in\""
  29     ":\"query\",\"name\":\"event\",\"required\":false,\"schema\":{\"type\":\""
  30     "string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/20"
  31     "0\"}}},\"/unsubscribe\":{\"description\":\"Unsubscribe previously suscri"
  32     "bed signals.\",\"parameters\":[{\"in\":\"query\",\"name\":\"event\",\"re"
  33     "quired\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\""
  34     ":{\"$ref\":\"#/components/responses/200\"}}},\"/get\":{\"description\":\""
  35     "get a current value of CAN message\",\"parameters\":[{\"in\":\"query\",\""
  36     "name\":\"event\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\""
  37     "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/list"
  38     "\":{\"description\":\"get a supported CAN message list\",\"responses\":{"
  39     "\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/auth\":{\"descrip"
  40     "tion\":\"Authenticate session to be raise Level Of Assurance.\",\"get\":"
  41     "{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/write\"},\"res"
  42     "ponses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/write\""
  43     ":{\"description\":\"Write a CAN messages to the CAN bus.\",\"get\":{\"x-"
  44     "permissions\":{\"LOA\":1},\"parameters\":[{\"in\":\"query\",\"name\":\"b"
  45     "us_name\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\""
  46     "query\",\"name\":\"frame\",\"required\":false,\"schema\":{\"type\":\"arr"
  47     "ay\"},\"parameters\":[{\"in\":\"query\",\"name\":\"can_id\",\"required\""
  48     ":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"ca"
  49     "n_dlc\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"q"
  50     "uery\",\"name\":\"can_data\",\"required\":false,\"schema\":{\"type\":\"s"
  51     "tring\"}}]},{\"in\":\"query\",\"name\":\"signal_name\",\"required\":fals"
  52     "e,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"signal_"
  53     "value\",\"required\":false,\"schema\":{\"type\":\"integer\"}}],\"respons"
  54     "es\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}}}}"
  55 ;
  56
  57 static const struct afb_auth _afb_auths_v2_low_can[] = {
  58         afb::auth_permission("urn:AGL:permission::platform:can:write ")
  59 };
  60
  61  void subscribe(struct afb_req req);
  62  void unsubscribe(struct afb_req req);
  63  void get(struct afb_req req);
  64  void list(struct afb_req req);
  65  void auth(struct afb_req req);
  66  void write(struct afb_req req);
  67
  68 static const struct afb_verb_v2 _afb_verbs_v2_low_can[] = {
  69     {
  70         .verb = "subscribe",
  71         .callback = subscribe,
  72         .auth = NULL,
  73         .info = "Subscribe to CAN signals events",
  74         .session = AFB_SESSION_NONE_V2
  75     },
  76     {
  77         .verb = "unsubscribe",
  78         .callback = unsubscribe,
  79         .auth = NULL,
  80         .info = "Unsubscribe previously suscribed signals.",
  81         .session = AFB_SESSION_NONE_V2
  82     },
  83     {
  84         .verb = "get",
  85         .callback = get,
  86         .auth = NULL,
  87         .info = "get a current value of CAN message",
  88         .session = AFB_SESSION_NONE_V2
  89     },
  90     {
  91         .verb = "list",
  92         .callback = list,
  93         .auth = NULL,
  94         .info = "get a supported CAN message list",
  95         .session = AFB_SESSION_NONE_V2
  96     },
  97     {
  98         .verb = "auth",
  99         .callback = auth,
 100         .auth = &_afb_auths_v2_low_can[0],
 101         .info = "Authenticate session to be raise Level Of Assurance.",
 102         .session = AFB_SESSION_NONE_V2
 103     },
 104     {
 105         .verb = "write",
 106         .callback = write,
 107         .auth = NULL,
 108         .info = "Write a CAN messages to the CAN bus.",
 109         .session = AFB_SESSION_LOA_1_V2
 110     },
 111     {
 112         .verb = NULL,
 113         .callback = NULL,
 114         .auth = NULL,
 115         .info = NULL,
 116         .session = 0
 117         }
 118 };
 119
 120 const struct afb_binding_v2 afbBindingV2 = {
 121     .api = "low-can",
 122     .specification = _afb_description_v2_low_can,
 123     .info = "",
 124     .verbs = _afb_verbs_v2_low_can,
 125     .preinit = NULL,
 126     .init = initv2,
 127     .onevent = NULL,
 128     .noconcurrency = 0
 129 };
 130