A11 (C++ runtime)
Native C++ implementation of the A11 action and streaming runtime
Loading...
Searching...
No Matches
a11::actions::ActionHeaderSchema Struct Reference

Schema for a single header an action accepts. More...

#include <cpp/a11/actions/schema.h>

Public Member Functions

absl::Status Validate () const
 Validates the header schema.
 

Public Attributes

std::string name
 Header name.
 
std::string description
 Human-readable description.
 
std::optional< data::Bytesdefault_value
 Value used when omitted.
 

Friends

bool operator== (const ActionHeaderSchema &, const ActionHeaderSchema &)=default
 

Detailed Description

Schema for a single header an action accepts.

Declares the header name, a description, and an optional default_value applied when the caller omits it.

Member Function Documentation

◆ Validate()

absl::Status a11::actions::ActionHeaderSchema::Validate ( ) const

Validates the header schema.

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ default_value

std::optional<data::Bytes> a11::actions::ActionHeaderSchema::default_value

Value used when omitted.

◆ description

std::string a11::actions::ActionHeaderSchema::description

Human-readable description.

◆ name

std::string a11::actions::ActionHeaderSchema::name

Header name.


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