WIP: "api" returns openapi, not method list

src/apps/js_generic/js_generic.cpp

@@ -285,15 +285,16 @@ namespace ccfapp
 
  // Since we do our own dispatch within the default handler, report the
  // supported methods here
- void list_methods(kv::Tx& tx, ListMethods::Out& out) override
+ void build_api(ds::openapi::Document& document, kv::Tx& tx) override
  {
- UserEndpointRegistry::list_methods(tx, out);
-
- auto scripts = tx.get_view(this->network.app_scripts);
- scripts->foreach([&out](const auto& key, const auto&) {
- out.methods.push_back(key);
- return true;
- });
+ UserEndpointRegistry::build_api(document, tx);
+
+ // TODO
+ // auto scripts = tx.get_view(this->network.app_scripts);
+ // scripts->foreach([&out](const auto& key, const auto&) {
+ // out.methods.push_back(key);
+ // return true;
+ // });
  }
  };
 

src/apps/lua_generic/lua_generic.cpp

@@ -189,18 +189,19 @@ namespace ccfapp
 
  // Since we do our own dispatch within the default handler, report the
  // supported methods here
- void list_methods(kv::Tx& tx, ListMethods::Out& out) override
+ void build_api(ds::openapi::Document& document, kv::Tx& tx) override
  {
- UserEndpointRegistry::list_methods(tx, out);
-
- auto scripts = tx.get_view(this->network.app_scripts);
- scripts->foreach([&out](const auto& key, const auto&) {
- if (key != UserScriptIds::ENV_HANDLER)
- {
- out.methods.push_back(key);
- }
- return true;
- });
+ UserEndpointRegistry::build_api(document, tx);
+
+ // TODO
+ // auto scripts = tx.get_view(this->network.app_scripts);
+ // scripts->foreach([&out](const auto& key, const auto&) {
+ // if (key != UserScriptIds::ENV_HANDLER)
+ // {
+ // out.methods.push_back(key);
+ // }
+ // return true;
+ // });
  }
  };
 

src/ds/test/openapi_schema.cpp

@@ -16,18 +16,15 @@ TEST_CASE("Basic doc")
  using namespace ds;
  openapi::Document doc;
  doc.info.title = "Test generated API";
- doc.info.description = "Some longer description enhance with **Markdown**";
+ doc.info.description = "Some longer description enhanced with **Markdown**";
  doc.info.version = "0.1.42";
 
- print_doc("INITIAL", doc);
-
  {
  openapi::Server mockup_server;
  mockup_server.url =
  "https://virtserver.swaggerhub.com/eddyashton/ccf-test/1.0.0";
  doc.servers.push_back(mockup_server);
  }
- print_doc("SERVERS", doc);
 
  {
  doc.paths["/users/foo"]

src/node/rpc/call_types.h

@@ -117,12 +117,10 @@ namespace ccf
  using Out = CallerInfo;
  };
 
- struct ListMethods
+ struct GetAPI
  {
- struct Out
- {
- std::vector<std::string> methods;
- };
+ // TODO: This is a ds::openapi::Document?
+ using Out = nlohmann::json;
  };
 
  struct GetSchema

src/node/rpc/common_endpoint_registry.h

@@ -24,8 +24,10 @@ namespace ccf
 
  public:
  CommonEndpointRegistry(
- kv::Store& store, const std::string& certs_table_name = "") :
- EndpointRegistry(store, certs_table_name),
+ const std::string& method_prefix_,
+ kv::Store& store,
+ const std::string& certs_table_name = "") :
+ EndpointRegistry(method_prefix_, store, certs_table_name),
  nodes(store.get<Nodes>(Tables::NODES)),
  tables(&store)
  {}
@@ -219,17 +221,13 @@ namespace ccf
  .set_auto_schema<GetNodesByRPCAddress::In, GetNodesByRPCAddress::Out>()
  .install();
 
- auto list_methods_fn = [this](kv::Tx& tx, nlohmann::json&& params) {
- ListMethods::Out out;
-
- list_methods(tx, out);
-
- std::sort(out.methods.begin(), out.methods.end());
-
- return make_success(out);
+ auto openapi = [this](kv::Tx& tx, nlohmann::json&& params) {
+ ds::openapi::Document document;
+ build_api(document, tx);
+ return make_success(document);
  };
- make_endpoint("api", HTTP_GET, json_adapter(list_methods_fn))
- .set_auto_schema<void, ListMethods::Out>()
+ make_endpoint("api", HTTP_GET, json_adapter(openapi))
+ .set_auto_schema<void, GetAPI::Out>()
  .install();
 
  auto get_schema = [this](auto& args, nlohmann::json&& params) {

src/node/rpc/endpoint_registry.h

@@ -4,6 +4,7 @@
 
 #include "ds/ccf_deprecated.h"
 #include "ds/json_schema.h"
+#include "ds/openapi_schema.h"
 #include "enclave/rpc_context.h"
 #include "http/http_consts.h"
 #include "kv/store.h"
@@ -68,6 +69,8 @@ namespace ccf
  Write
  };
 
+ const std::string method_prefix;
+
  /** An Endpoint represents a user-defined resource that can be invoked by
  * authorised users via HTTP requests, over TLS. An Endpoint is accessible
  * at a specific verb and URI, e.g. POST /app/accounts or GET /app/records.
@@ -305,7 +308,10 @@ namespace ccf
 
  public:
  EndpointRegistry(
- kv::Store& tables, const std::string& certs_table_name = "")
+ const std::string& method_prefix_,
+ kv::Store& tables,
+ const std::string& certs_table_name = "") :
+ method_prefix(method_prefix_)
  {
  if (!certs_table_name.empty())
  {
@@ -432,17 +438,19 @@ namespace ccf
  return default_handler.value();
  }
 
- /** Populate out with all supported methods
- *
- * This is virtual since the default endpoint may do its own dispatch
- * internally, so derived implementations must be able to populate the list
- * with the supported methods however it constructs them.
- */
- virtual void list_methods(kv::Tx& tx, ListMethods::Out& out)
+ // TODO: May want the entire rpc context, not just tx?
+ virtual void build_api(ds::openapi::Document& document, kv::Tx& tx)
  {
  for (const auto& [method, verb_handlers] : installed_handlers)
  {
- out.methods.push_back(method);
+ const auto full_path = fmt::format("/{}/{}", method_prefix, method);
+ auto& path_object = document.paths[full_path];
+ for (const auto& [verb, handler] : verb_handlers)
+ {
+ path_object.operations[verb]
+ .responses[std::to_string(HTTP_STATUS_OK)]
+ .description = "Auto-generated";
+ }
  }
  }
 

src/node/rpc/member_frontend.h

@@ -549,7 +549,10 @@ namespace ccf
  NetworkTables& network,
  AbstractNodeState& node,
  ShareManager& share_manager) :
- CommonEndpointRegistry(*network.tables, Tables::MEMBER_CERTS),
+ CommonEndpointRegistry(
+ get_actor_prefix(ActorsType::members),
+ *network.tables,
+ Tables::MEMBER_CERTS),
  network(network),
  node(node),
  share_manager(share_manager),

src/node/rpc/node_frontend.h

@@ -138,7 +138,8 @@ namespace ccf
 
  public:
  NodeEndpoints(NetworkState& network, AbstractNodeState& node) :
- CommonEndpointRegistry(*network.tables),
+ CommonEndpointRegistry(
+ get_actor_prefix(ActorsType::nodes), *network.tables),
  network(network),
  node(node)
  {}

src/node/rpc/serialization.h

@@ -108,8 +108,7 @@ namespace ccf
  DECLARE_JSON_TYPE(GetUserId::In)
  DECLARE_JSON_REQUIRED_FIELDS(GetUserId::In, cert)
 
- DECLARE_JSON_TYPE(ListMethods::Out)
- DECLARE_JSON_REQUIRED_FIELDS(ListMethods::Out, methods)
+ DECLARE_JSON_TYPE(GetAPI::Out)
 
  DECLARE_JSON_TYPE(GetSchema::In)
  DECLARE_JSON_REQUIRED_FIELDS(GetSchema::In, method)

src/node/rpc/test/frontend_test.cpp

@@ -224,7 +224,7 @@ class TestNoCertsFrontend : public RpcFrontend
 public:
  TestNoCertsFrontend(kv::Store& tables) :
  RpcFrontend(tables, endpoints),
- endpoints(tables)
+ endpoints("test", tables)
  {
  open();
 

src/node/rpc/user_frontend.h

@@ -81,11 +81,12 @@ namespace ccf
  {
  public:
  UserEndpointRegistry(kv::Store& store) :
- CommonEndpointRegistry(store, Tables::USER_CERTS)
+ CommonEndpointRegistry(
+ get_actor_prefix(ActorsType::users), store, Tables::USER_CERTS)
  {}
 
  UserEndpointRegistry(NetworkTables& network) :
- CommonEndpointRegistry(*network.tables, Tables::USER_CERTS)
+ UserEndpointRegistry(*network.tables)
  {}
  };
 

tests/schema.py

@@ -33,6 +33,7 @@ def fetch_schema(client):
  check(
  list_response, error=lambda status, msg: status == http.HTTPStatus.OK.value
  )
+ LOG.warning(list_response)
  methods = list_response.result["methods"]
 
  for method in methods: