Boost C++ Libraries

PrevUpHomeNext

Struct description

boost::taar::handler::description — Human-readable description for a body argument provider.

Synopsis

// In header: <boost/taar/handler/rest_arg.hpp>


struct description {

  // public data members
  std::string text;
};

Description

Body providers take content types as positional strings, so their description is passed through this tag instead: json_body_arg(description {"The user to create"}). Named providers (path_arg, query_arg, header_arg, cookie_arg) accept the description as a plain trailing string. Descriptions feed generated documentation such as OpenAPI.


PrevUpHomeNext