rux::gui::Endpoint Struct Reference

One row of the route table. More...

#include <api.hpp>

Collaboration diagram for rux::gui::Endpoint:

Public Attributes
std::string	method
std::string	path
	Crow route pattern, e.g. "/api/v1/clouds/<string>".
std::string	summary
	Matches the OpenAPI summary for the same path.
bool	binary = false
	True when the response is not JSON.

Detailed Description

One row of the route table.

The table is the single source of truth for both route registration and the self-describing /endpoints response.

Definition at line 107 of file api.hpp.

Member Data Documentation

binary

bool rux::gui::Endpoint::binary = false

True when the response is not JSON.

Definition at line 111 of file api.hpp.

method

std::string rux::gui::Endpoint::method

Definition at line 108 of file api.hpp.

path

std::string rux::gui::Endpoint::path

Crow route pattern, e.g. "/api/v1/clouds/<string>".

Definition at line 109 of file api.hpp.

summary

std::string rux::gui::Endpoint::summary

Matches the OpenAPI summary for the same path.

Definition at line 110 of file api.hpp.

---

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

• apps/rux/include/gui/api.hpp