2018-10-20 14:20:06 +02:00
|
|
|
/** The "capabiltities" API ressource.
|
|
|
|
*
|
2022-12-14 17:41:58 +01:00
|
|
|
* @author Steffen Vogel <post@steffenvogel.de>
|
2022-03-15 09:28:57 -04:00
|
|
|
* @copyright 2014-2022, Institute for Automation of Complex Power Systems, EONERC
|
2022-07-04 18:20:03 +02:00
|
|
|
* @license Apache 2.0
|
2018-10-20 14:20:06 +02:00
|
|
|
*********************************************************************************/
|
|
|
|
|
2020-08-17 17:03:54 +02:00
|
|
|
#include <villas/api/request.hpp>
|
|
|
|
#include <villas/api/response.hpp>
|
2021-09-21 15:22:09 +02:00
|
|
|
#include <villas/capabilities.hpp>
|
2018-10-20 14:20:06 +02:00
|
|
|
|
|
|
|
namespace villas {
|
|
|
|
namespace node {
|
|
|
|
namespace api {
|
|
|
|
|
2020-08-17 17:03:54 +02:00
|
|
|
class CapabilitiesRequest : public Request {
|
2018-10-20 14:20:06 +02:00
|
|
|
|
|
|
|
public:
|
2020-08-17 17:03:54 +02:00
|
|
|
using Request::Request;
|
2019-01-21 10:34:22 +01:00
|
|
|
|
2020-08-17 17:03:54 +02:00
|
|
|
virtual Response * execute()
|
2018-10-20 14:20:06 +02:00
|
|
|
{
|
2020-09-30 17:56:12 +02:00
|
|
|
if (method != Session::Method::GET)
|
2020-08-17 17:03:54 +02:00
|
|
|
throw InvalidMethod(this);
|
|
|
|
|
|
|
|
if (body != nullptr)
|
|
|
|
throw BadRequest("Capabilities endpoint does not accept any body data");
|
|
|
|
|
2021-09-21 15:22:09 +02:00
|
|
|
auto *json_capabilities = getCapabilities();
|
2018-10-20 14:20:06 +02:00
|
|
|
|
2020-10-20 22:17:55 +02:00
|
|
|
return new JsonResponse(session, HTTP_STATUS_OK, json_capabilities);
|
2018-10-20 14:20:06 +02:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2020-08-17 17:03:54 +02:00
|
|
|
/* Register API request */
|
2020-06-14 15:00:02 +02:00
|
|
|
static char n[] = "capabilities";
|
2020-08-17 17:03:54 +02:00
|
|
|
static char r[] = "/capabilities";
|
2020-06-14 15:00:02 +02:00
|
|
|
static char d[] = "get capabiltities and details about this VILLASnode instance";
|
2020-08-17 17:03:54 +02:00
|
|
|
static RequestPlugin<CapabilitiesRequest, n, r, d> p;
|
2018-10-20 14:20:06 +02:00
|
|
|
|
2023-08-28 09:34:02 +02:00
|
|
|
} // namespace api
|
|
|
|
} // namespace node
|
|
|
|
} // namespace villas
|