diff options
| author |   Jose Bollo <jose.bollo@iot.bzh> | 2018-08-20 14:44:31 +0200 |
|---|---|---|
| committer | Jose Bollo <jose.bollo@iot.bzh> | 2018-08-20 14:44:31 +0200 |
| commit | 6492d061bf5753bb3bb67b771fc2f9ce0c910c2b (patch) | |
| tree | 1b8f7c267e8028934ec5cf8e8965deb98c662423 /docs/reference-v3/func-api.md | |
| parent | 57a4177d8d0f5c0bbc88f18a4d593f7cf2c8ba55 (diff) | |
Provide functions afb_service_call[_sync]_legacy
These functions was missing and the documentation
was erronous. This fixes that issue by providing
the missing functions and updating the documentation.
Bug-AGL: SPEC-1669
Change-Id: I543b0fbe29370be6f35f15ca3bfa48fef9ab4055
Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs/reference-v3/func-api.md')
| -rw-r--r-- | docs/reference-v3/func-api.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/reference-v3/func-api.md b/docs/reference-v3/func-api.md index ef3816d0..aa28932a 100644 --- a/docs/reference-v3/func-api.md +++ b/docs/reference-v3/func-api.md @@ -279,7 +279,7 @@ struct json_object *afb_api_settings( ```C /** - * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. + * Calls the 'verb' of the 'apiname' with the arguments 'args' and 'verb' in the name of the binding 'api'. * The result of the call is delivered to the 'callback' function with the 'callback_closure'. * * For convenience, the function calls 'json_object_put' for 'args'. @@ -323,7 +323,7 @@ void afb_api_call( ```C /** - * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. + * Calls the 'verb' of the 'apiname' with the arguments 'args' and 'verb' in the name of the binding 'api'. * 'result' will receive the response. * * For convenience, the function calls 'json_object_put' for 'args'. @@ -880,8 +880,10 @@ of work. /** * @deprecated try to use @ref afb_api_call instead * - * * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. - * The result of the call is delivered to the 'callback' function with the 'callback_closure'. + * Calls the 'verb' of the 'apiname' with the arguments 'args' and 'verb' + * in the name of the binding. + * The result of the call is delivered to the 'callback' function + * with the 'callback_closure'. * * For convenience, the function calls 'json_object_put' for 'args'. * Thus, in the case where 'args' should remain available after @@ -924,7 +926,8 @@ void afb_api_call_legacy( /** * @deprecated try to use @ref afb_api_call_sync instead * - * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. + * Calls the 'verb' of the 'apiname' with the arguments 'args' and 'verb' + * in the name of the binding. * 'result' will receive the response. * * For convenience, the function calls 'json_object_put' for 'args'. |