proxy-wasm-rust-sdk icon indicating copy to clipboard operation
proxy-wasm-rust-sdk copied to clipboard

Document hostcalls::dispatch_http_call

Open younes-io opened this issue 1 year ago • 7 comments

I think functions should be documented to make it easy to find (regardless of the ABI, which is now being written, cf. https://github.com/proxy-wasm/spec/issues/41)

younes-io avatar Jun 18 '23 12:06 younes-io

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

google-cla[bot] avatar Jun 18 '23 12:06 google-cla[bot]

is there any issue here ?

younes-io avatar Jun 20 '23 19:06 younes-io

is there any issue here ?

It doesn't pass tests (see Clippy failures).

Also, I believe that @mpwarres and @martijneken are currently working on the documentation for the whole SDK, so it might be worth waiting a bit for it for the sake of consistency. @mpwarres @martijneken do you have status update?

PiotrSikora avatar Jun 21 '23 18:06 PiotrSikora

Also, I believe that @mpwarres and @martijneken are currently working on the documentation for the whole SDK, so it might be worth waiting a bit for it for the sake of consistency. @mpwarres @martijneken do you have status update?

C++ SDK doc PR should be out end of this week, Rust SDK PR early next week.

mpwarres avatar Jul 06 '23 16:07 mpwarres

/// # Returns /// /// A Result indicating the success or failure of the HTTP call. If the call is successful, the function returns an HTTP status code as a u32. If an error occurs, an Error object is returned.

There may be some problems with this description. It seems that the return is not an HTTP status code, but the code looks more like a token_id

cuisongliu avatar Aug 02 '23 16:08 cuisongliu

@PiotrSikora : is this still relevant or shall I close it ?

younes-io avatar Dec 24 '23 20:12 younes-io

@mpwarres : could you please tell if this PR is still relevant or is obsolete (due to the latest work on docs, etc) ?

younes-io avatar Dec 27 '23 08:12 younes-io