ccf::endpoints::EndpointProperties Struct Reference

#include <endpoint.h>

Public Attributes
Mode	mode = Mode::ReadWrite
	Endpoint mode.
ForwardingRequired	forwarding_required = ForwardingRequired::Always
	Endpoint forwarding policy.
RedirectionStrategy	redirection_strategy = RedirectionStrategy::ToPrimary
	Endpoint redirection policy.
std::vector< nlohmann::json >	authn_policies = {}
	Authentication policies.
nlohmann::json	openapi
	OpenAPI schema for endpoint.
bool	openapi_hidden = false
std::string	js_module
	JavaScript module.
std::string	js_function
	JavaScript function name.
std::optional< InterpreterReusePolicy >	interpreter_reuse = std::nullopt

Member Data Documentation

authn_policies

std::vector<nlohmann::json> ccf::endpoints::EndpointProperties::authn_policies = {}

Authentication policies.

forwarding_required

ForwardingRequired ccf::endpoints::EndpointProperties::forwarding_required = ForwardingRequired::Always

Endpoint forwarding policy.

interpreter_reuse

std::optional<InterpreterReusePolicy> ccf::endpoints::EndpointProperties::interpreter_reuse = std::nullopt

Determines how JS interpreters may be reused between multiple calls, sharing global state in potentially unsafe ways. The default empty value means no reuse is permitted.

js_function

std::string ccf::endpoints::EndpointProperties::js_function

JavaScript function name.

js_module

std::string ccf::endpoints::EndpointProperties::js_module

JavaScript module.

mode

Mode ccf::endpoints::EndpointProperties::mode = Mode::ReadWrite

Endpoint mode.

openapi

nlohmann::json ccf::endpoints::EndpointProperties::openapi

OpenAPI schema for endpoint.

openapi_hidden

bool ccf::endpoints::EndpointProperties::openapi_hidden = false

redirection_strategy

RedirectionStrategy ccf::endpoints::EndpointProperties::redirection_strategy = RedirectionStrategy::ToPrimary

Endpoint redirection policy.

---

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

• include/ccf/endpoint.h