Boost C++ Libraries

PrevUpHomeNext

Struct operation

boost::taar::openapi::operation — Per-operation documentation supplied at registration through generator::describe.

Synopsis

// In header: <boost/taar/openapi/generator.hpp>


struct operation {

  // public data members
  std::string summary;
  std::string description;
  std::vector< std::string > tags;
  std::string operation_id;
  std::map< std::string, std::string > responses;  // Status code -> description. Replaces the generated default response when non-empty. 
  bool deprecated;
  std::vector< std::string > security;  // Security scheme names this operation accepts (alternatives). 
  bool anonymous;  // Emit security: []: no credentials even when the document requires some. 
};

Description

operation public public data members

  1. std::vector< std::string > security;

    Empty inherits the document's security, or what the generator infers from header/cookie constraints that match a registered scheme.


PrevUpHomeNext