Skip to content

Api

#include <mrx/spoke-zone/api/Api.hpp>
class mrx::spokezone::Api

Provides configured access to the Spoke.Zone API.

All generated service APIs share one OpenApiClient, configured from the supplied SpokeZoneConfig. The config must have loaded successfully before construction. The client is updated when the config’s API server or token changes; those updates stop if the config is destroyed. The client and service APIs are owned by value; accordingly, this entrypoint is neither copyable nor movable.

ReturnNameDescription
Api inline explicitConstructs the API entrypoint using the loaded Spoke.Zone configuration.
ApiDeleted constructor.
Api&operator=Deleted assignment operator.
ApiDeleted constructor.
Api&operator=Deleted assignment operator.
AuthenticationApi&auth inline
DevicesApi&devices inline
DataFilesApi&dataFiles inline
OtaFilesApi&otaFiles inline

inline explicit
inline explicit Api(const SpokeZoneConfig& config)

Constructs the API entrypoint using the loaded Spoke.Zone configuration.

NameTypeDescription
configconst SpokeZoneConfig&Successfully loaded Spoke.Zone configuration.

Api(const Api&) = delete

Deleted constructor.


Api& operator=(const Api&) = delete

Deleted assignment operator.


Api(Api&&) = delete

Deleted constructor.


Api& operator=(Api&&) = delete

Deleted assignment operator.


inline
inline AuthenticationApi& auth()

The authentication API.


inline
inline DevicesApi& devices()

The device API.


inline
inline DataFilesApi& dataFiles()

The data files API.


inline
inline OtaFilesApi& otaFiles()

The OTA files API.