Get to compilation

CMakeLists.txt

@@ -253,9 +253,9 @@ if(BUILD_TESTS)
  )
 
  add_unit_test(
- openapi ${CMAKE_CURRENT_SOURCE_DIR}/src/ds/test/openapi.cpp
+ openapi_test ${CMAKE_CURRENT_SOURCE_DIR}/src/ds/test/openapi.cpp
  )
- target_link_libraries(openapi PRIVATE http_parser.host)
+ target_link_libraries(openapi_test PRIVATE http_parser.host)
 
  add_unit_test(
  logger_json_test

src/apps/js_generic/js_generic.cpp

@@ -584,7 +584,7 @@ namespace ccfapp
 
  // Since we do our own dispatch within the default handler, report the
  // supported methods here
- void build_api(ds::openapi::Document& document, kv::Tx& tx) override
+ void build_api(nlohmann::json& document, kv::Tx& tx) override
  {
  UserEndpointRegistry::build_api(document, tx);
 

src/apps/lua_generic/lua_generic.cpp

@@ -187,7 +187,7 @@ namespace ccfapp
 
  // Since we do our own dispatch within the default handler, report the
  // supported methods here
- void build_api(ds::openapi::Document& document, kv::Tx& tx) override
+ void build_api(nlohmann::json& document, kv::Tx& tx) override
  {
  UserEndpointRegistry::build_api(document, tx);
 

src/ds/json.h

@@ -549,7 +549,7 @@ namespace std
  fill_json_schema_required_fields(j, t); \
  POST_FILL_SCHEMA; \
  } \
- inline std::string schema_name(const TYPE& t) \
+ inline std::string schema_name(const TYPE&) \
  { \
  return #TYPE; \
  } \
@@ -599,31 +599,36 @@ namespace std
  add_schema_components_optional_fields(doc, j, t))
 
 #define DECLARE_JSON_REQUIRED_FIELDS(TYPE, ...) \
- inline void to_json_required_fields(nlohmann::json& j, const TYPE& t) \
+ inline void to_json_required_fields( \
+ nlohmann::json& j, [[maybe_unused]] const TYPE& t) \
  { \
  if (!j.is_object()) \
  { \
  j = nlohmann::json::object(); \
  } \
  _FOR_JSON_COUNT_NN(__VA_ARGS__)(POP1)(WRITE_REQUIRED, TYPE, ##__VA_ARGS__) \
  } \
- inline void from_json_required_fields(const nlohmann::json& j, TYPE& t) \
+ inline void from_json_required_fields( \
+ const nlohmann::json& j, [[maybe_unused]] TYPE& t) \
  { \
  if (!j.is_object()) \
  { \
  throw JsonParseError("Expected object, found: " + j.dump()); \
  } \
  _FOR_JSON_COUNT_NN(__VA_ARGS__)(POP1)(READ_REQUIRED, TYPE, ##__VA_ARGS__) \
  } \
- inline void fill_json_schema_required_fields(nlohmann::json& j, const TYPE&) \
+ inline void fill_json_schema_required_fields( \
+ nlohmann::json& j, [[maybe_unused]] const TYPE& t) \
  { \
  j["type"] = "object"; \
  _FOR_JSON_COUNT_NN(__VA_ARGS__) \
  (POP1)(FILL_SCHEMA_REQUIRED, TYPE, ##__VA_ARGS__) \
  } \
  template <typename T> \
  void add_schema_components_required_fields( \
- T& doc, nlohmann::json& j, const TYPE& t) \
+ [[maybe_unused]] T& doc, \
+ nlohmann::json& j, \
+ [[maybe_unused]] const TYPE& t) \
  { \
  j["type"] = "object"; \
  _FOR_JSON_COUNT_NN(__VA_ARGS__) \
@@ -681,7 +686,7 @@ namespace std
  } \
  template <typename T> \
  void add_schema_components_optional_fields( \
- T& doc, nlohmann::json& j, const TYPE& t) \
+ T& doc, nlohmann::json& j, const TYPE&) \
  { \
  _FOR_JSON_COUNT_NN(__VA_ARGS__) \
  (POP1)(ADD_SCHEMA_COMPONENTS_OPTIONAL, TYPE, ##__VA_ARGS__); \

src/ds/nonstd.h

@@ -64,14 +64,14 @@ namespace nonstd
 
  /** converts strings to upper or lower case, in-place
  */
- static void to_upper(std::string& s)
+ static inline void to_upper(std::string& s)
  {
  std::transform(s.begin(), s.end(), s.begin(), [](unsigned char c) {
  return std::toupper(c);
  });
  }
 
- static void to_lower(std::string& s)
+ static inline void to_lower(std::string& s)
  {
  std::transform(s.begin(), s.end(), s.begin(), [](unsigned char c) {
  return std::tolower(c);

src/ds/openapi.h

@@ -9,6 +9,9 @@
 #include <nlohmann/json.hpp>
 #include <string>
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments"
+
 namespace ds
 {
  /**
@@ -21,20 +24,22 @@ namespace ds
  {
  namespace access
  {
- static nlohmann::json& get_object(nlohmann::json& j, const std::string& k)
+ static inline nlohmann::json& get_object(
+ nlohmann::json& j, const std::string& k)
  {
  const auto ib = j.emplace(k, nlohmann::json::object());
  return ib.first.value();
  }
 
- static nlohmann::json& get_array(nlohmann::json& j, const std::string& k)
+ static inline nlohmann::json& get_array(
+ nlohmann::json& j, const std::string& k)
  {
  const auto ib = j.emplace(k, nlohmann::json::array());
  return ib.first.value();
  }
  }
 
- static nlohmann::json create_document(
+ static inline nlohmann::json create_document(
  const std::string& title,
  const std::string& description,
  const std::string& document_version)
@@ -49,29 +54,39 @@ namespace ds
  {"paths", nlohmann::json::object()}};
  }
 
- static nlohmann::json& server(nlohmann::json& document, const std::string& url)
+ static inline nlohmann::json& server(
+ nlohmann::json& document, const std::string& url)
  {
  auto& servers = access::get_object(document, "servers");
  servers.push_back({{"url", url}});
  return servers.back();
  }
 
- static nlohmann::json& path(nlohmann::json& document, const std::string& path)
+ static inline nlohmann::json& path(
+ nlohmann::json& document, const std::string& path)
  {
  // TODO: Check that path starts with /?
  auto& paths = access::get_object(document, "paths");
  return access::get_object(paths, path);
  }
 
- static nlohmann::json& path_operation(nlohmann::json& path, http_method verb)
+ static inline nlohmann::json& path_operation(
+ nlohmann::json& path, http_method verb)
  {
  // HTTP_GET becomes the string "get"
  std::string s = http_method_str(verb);
  nonstd::to_lower(s);
  return access::get_object(path, s);
  }
 
- static nlohmann::json& response(
+ static inline nlohmann::json& path_operation(
+ nlohmann::json& path, std::string s)
+ {
+ nonstd::to_lower(s);
+ return access::get_object(path, s);
+ }
+
+ static inline nlohmann::json& response(
  nlohmann::json& path_operation,
  http_status status,
  const std::string& description = "Default response description")
@@ -85,19 +100,15 @@ namespace ds
  return response;
  }
 
- static nlohmann::json& request_body(
- nlohmann::json& path_operation
- )
+ static inline nlohmann::json& request_body(nlohmann::json& path_operation)
  {
  auto& request_body = access::get_object(path_operation, "requestBody");
  access::get_object(request_body, "content");
  return request_body;
  }
 
- static nlohmann::json& media_type(
- nlohmann::json& j,
- const std::string& mt
- )
+ static inline nlohmann::json& media_type(
+ nlohmann::json& j, const std::string& mt)
  {
  auto& content = access::get_object(j, "content");
  return access::get_object(content, mt);
@@ -402,3 +413,5 @@ namespace ds
  DECLARE_JSON_OPTIONAL_FIELDS(Document, servers, components);
  }
 }
+
+#pragma clang diagnostic pop

src/node/rpc/call_types.h

@@ -134,18 +134,8 @@ namespace ccf
 
  struct GetAPI
  {
- struct Endpoint
- {
- std::string verb;
- std::string path;
- };
-
  // TODO: What is the format of this now?
- //using Out = nlohmann::json;
- struct Out
- {
- std::vector<Endpoint> endpoints;
- };
+ using Out = nlohmann::json;
  };
 
  struct EndpointMetrics

src/node/rpc/common_endpoint_registry.h

@@ -218,7 +218,8 @@ namespace ccf
  .install();
 
  auto openapi = [this](kv::Tx& tx, nlohmann::json&&) {
- ds::openapi::Document document;
+ // TODO: Update these
+ auto document = ds::openapi::create_document("Placeholder title", "Placeholder description", "1.0.0");
  build_api(document, tx);
  return make_success(document);
  };
@@ -276,10 +277,9 @@ namespace ccf
 
  if (j.empty())
  {
- std::string verb_name = http_method_str(verb);
- nonstd::to_lower(verb_name);
- j[verb_name] =
- GetSchema::Out{endpoint.params_schema, endpoint.result_schema};
+ return make_error(
+ HTTP_STATUS_BAD_REQUEST,
+ fmt::format("Method {} not recognised", in.method));
  }
 
  return make_success(j);

src/node/rpc/endpoint_registry.h

@@ -449,15 +449,20 @@ namespace ccf
  * with the supported endpoints however it defines them.
  */
  // TODO: May want the entire rpc context, not just tx?
- virtual void build_api(ds::openapi::Document& document, kv::Tx& tx)
+ virtual void build_api(nlohmann::json& document, kv::Tx&)
  {
  for (const auto& [path, verb_endpoints] : fully_qualified_endpoints)
  {
- const auto full_path = fmt::format("/{}/{}", method_prefix, method);
- auto& path_object = document.paths[full_path];
- for (const auto& [verb, handler] : verb_handlers)
+ const auto full_path = fmt::format("/{}/{}", method_prefix, path);
+ auto& path_object = ds::openapi::path(document, "/users/foo");
+ for (const auto& [verb, handler] : verb_endpoints)
  {
- path_object[verb][HTTP_STATUS_OK].description = "Auto-generated";
+ auto& path_operation = ds::openapi::path_operation(path_object, verb.c_str());
+ auto& path_response_ok = ds::openapi::response(
+ path_operation, HTTP_STATUS_OK, "Auto-generated");
+ auto& path_response_ok_json = ds::openapi::media_type(
+ path_response_ok, http::headervalues::contenttype::JSON);
+ path_response_ok_json["schema"] = "Placeholder";
  }
  }
 

src/node/rpc/serialization.h

@@ -112,12 +112,6 @@ namespace ccf
  DECLARE_JSON_TYPE(GetUserId::In)
  DECLARE_JSON_REQUIRED_FIELDS(GetUserId::In, cert)
 
- //DECLARE_JSON_TYPE(GetAPI::Out)
- DECLARE_JSON_TYPE(ListMethods::Endpoint)
- DECLARE_JSON_REQUIRED_FIELDS(ListMethods::Endpoint, verb, path)
- DECLARE_JSON_TYPE(ListMethods::Out)
- DECLARE_JSON_REQUIRED_FIELDS(ListMethods::Out, endpoints)
-
  DECLARE_JSON_TYPE(EndpointMetrics::Metric)
  DECLARE_JSON_REQUIRED_FIELDS(EndpointMetrics::Metric, calls, errors, failures)
  DECLARE_JSON_TYPE(EndpointMetrics::Out)