Add sample handler and docs for non-JSON body #977
Conversation
|
non_json_body_sample@6303 aka 20200323.65 vs master ewma over 30 builds from 5972 to 6297 |
| @@ -57,17 +57,29 @@ The logging app defines :cpp:class:`ccfapp::LoggerHandlers`, which creates and i | |||
| :end-before: SNIPPET_END: get | |||
There was a problem hiding this comment.
I wonder if it's worth adding a new page/section that describes the different types and options on handlers without mentioning the logging app specifically? I think we'll need one sooner or later to describe the different types/flags on handlers. We could always link to the logging app as examples (with back links too). Thinking about it, we should doxygen handlerregistry.h and get most of this for free. What do you think?
There was a problem hiding this comment.
I agree! This is where we should aim, ideally with most of this coming 'for free' from doxygen. I think the next step is to split the thing apps see from the thing the framework sees (ie - they get an opaque Handle with the methods, we see the raw struct state), then the app side gets doxygen'd.
Naming is awkward - what's a 'handle' for a 'handler'? Maybe we should go more HTTP-heavy and talk about installing resources or endpoints rather than RPC handlers?
Anyway I think this is all future work.
There was a problem hiding this comment.
doxygen + links is absolutely the way to go! For naming, I think we should pick a popular framework, align, and reference explicitly.
We've supported non-JSON bodies in the framework for a while, but we didn't have a sample. This adds a sample in the C++ logging app, adds some docs, and tweaks the Python infra to allow these payloads though unhindered.