Public Member Functions
	PathTemplatedEndpoint (const Endpoint &e)

Public Member Functions inherited from ccf::endpoints::Endpoint
Endpoint &	set_openapi_description (const std::string &description)

Endpoint &	set_openapi_summary (const std::string &summary)

Endpoint &	set_openapi_deprecated (bool is_deprecated)

Endpoint &	set_openapi_deprecated_replaced (const std::string &deprecation_version, const std::string &replacement)

Endpoint &	set_openapi_hidden (bool hidden)

Endpoint &	require_operator_feature (OperatorFeature feature)

Endpoint &	set_params_schema (const nlohmann::json &j)

Endpoint &	set_result_schema (const nlohmann::json &j, std::optional< http_status > status=std::nullopt)

template<typename In , typename Out >
Endpoint &	set_auto_schema (std::optional< http_status > status=std::nullopt)

template<typename T >
Endpoint &	set_auto_schema (std::optional< http_status > status=std::nullopt)

template<typename T >
Endpoint &	add_query_parameter (const std::string &param_name, QueryParamPresence presence=QueryParamPresence::RequiredParameter)

Endpoint &	set_forwarding_required (ForwardingRequired fr)

Endpoint &	set_redirection_strategy (RedirectionStrategy rs)

Endpoint &	set_locally_committed_function (const LocallyCommittedEndpointFunction &lcf)

void	install ()

Public Member Functions inherited from ccf::endpoints::EndpointDefinition
virtual	~EndpointDefinition ()=default

Public Attributes
PathTemplateSpec	spec

Public Attributes inherited from ccf::endpoints::Endpoint
EndpointFunction	func

LocallyCommittedEndpointFunction	locally_committed_func

Installer *	installer = nullptr

std::vector< SchemaBuilderFn >	schema_builders

bool	openapi_hidden = false

http_status	success_status = HTTP_STATUS_OK

nlohmann::json	params_schema = nullptr

nlohmann::json	result_schema = nullptr

std::optional< std::string >	openapi_summary = std::nullopt

std::optional< std::string >	openapi_description = std::nullopt

std::optional< bool >	openapi_deprecated = std::nullopt

Public Attributes inherited from ccf::endpoints::EndpointDefinition
EndpointKey	dispatch

URI	full_uri_path
	Full URI path to endpoint, including method prefix.

EndpointProperties	properties

AuthnPolicies	authn_policies

std::set< OperatorFeature >	required_operator_features

Additional Inherited Members
Public Types inherited from ccf::endpoints::Endpoint
using	SchemaBuilderFn = std::function< void(nlohmann::json &, const Endpoint &)>

Constructor & Destructor Documentation

◆ PathTemplatedEndpoint()

ccf::endpoints::PathTemplatedEndpoint::PathTemplatedEndpoint ( const Endpoint & e )

inline

PathTemplateSpec ccf::endpoints::PathTemplatedEndpoint::spec

The documentation for this struct was generated from the following file: