Make OpenAPI info customisable

doc/schemas/app_openapi.json

@@ -383,9 +383,9 @@
  }
  },
  "info": {
- "description": "Placeholder description",
- "title": "Placeholder title",
- "version": "1.0.0"
+ "description": "This CCF sample app implements a simple logging application, securely recording messages at client-specified IDs. It demonstrates most of the features available to CCF apps.",
+ "title": "CCF Sample Logging App",
+ "version": "0.0.1"
  },
  "openapi": "3.0.0",
  "paths": {

doc/schemas/gov_openapi.json

@@ -553,9 +553,9 @@
  }
  },
  "info": {
- "description": "Placeholder description",
- "title": "Placeholder title",
- "version": "1.0.0"
+ "description": "This API is used to submit and query proposals which affect CCF's public governance tables.",
+ "title": "CCF Governance API",
+ "version": "0.0.1"
  },
  "openapi": "3.0.0",
  "paths": {

doc/schemas/node_openapi.json

@@ -420,9 +420,9 @@
  }
  },
  "info": {
- "description": "Placeholder description",
- "title": "Placeholder title",
- "version": "1.0.0"
+ "description": "This API provides public, uncredentialed access to service and node state.",
+ "title": "CCF Public Node API",
+ "version": "0.0.1"
  },
  "openapi": "3.0.0",
  "paths": {

src/apps/logging/logging.cpp

@@ -69,6 +69,12 @@ namespace loggingapp
  get_public_params_schema(nlohmann::json::parse(j_get_public_in)),
  get_public_result_schema(nlohmann::json::parse(j_get_public_out))
  {
+ openapi_info.title = "CCF Sample Logging App";
+ openapi_info.description =
+ "This CCF sample app implements a simple logging application, securely "
+ "recording messages at client-specified IDs. It demonstrates most of "
+ "the features available to CCF apps.";
+
  // SNIPPET_START: record
  auto record = [this](kv::Tx& tx, nlohmann::json&& params) {
  // SNIPPET_START: macro_validation_record

src/node/rpc/common_endpoint_registry.h

@@ -224,9 +224,10 @@ namespace ccf
  .install();
 
  auto openapi = [this](kv::Tx& tx, nlohmann::json&&) {
- // TODO: Update these
  auto document = ds::openapi::create_document(
- "Placeholder title", "Placeholder description", "1.0.0");
+ openapi_info.title,
+ openapi_info.description,
+ openapi_info.document_version);
  build_api(document, tx);
  return make_success(document);
  };
@@ -258,8 +259,7 @@ namespace ccf
 
  return make_success(j);
  };
- make_endpoint(
- "api/schema", HTTP_GET, json_adapter(get_schema))
+ make_endpoint("api/schema", HTTP_GET, json_adapter(get_schema))
  .set_auto_schema<GetSchema>()
  .install();
 

src/node/rpc/endpoint_registry.h

@@ -68,6 +68,13 @@ namespace ccf
 
  const std::string method_prefix;
 
+ struct OpenApiInfo
+ {
+ std::string title = "Empty title";
+ std::string description = "Empty description";
+ std::string document_version = "0.0.1";
+ } openapi_info;
+
  struct Metrics
  {
  size_t calls = 0;
@@ -435,8 +442,6 @@ namespace ccf
  return templated;
  }
 
- // TODO: Don't re-parse this here, set the parameters explicitly and
- // individually
  static void add_query_parameters(
  nlohmann::json& document,
  const std::string& uri,

src/node/rpc/member_frontend.h

@@ -760,7 +760,12 @@ namespace ccf
  node(node),
  share_manager(share_manager),
  tsr(network)
- {}
+ {
+ openapi_info.title = "CCF Governance API";
+ openapi_info.description =
+ "This API is used to submit and query proposals which affect CCF's "
+ "public governance tables.";
+ }
 
  void init_handlers(kv::Store& tables_) override
  {

src/node/rpc/node_frontend.h

@@ -140,7 +140,12 @@ namespace ccf
  get_actor_prefix(ActorsType::nodes), *network.tables),
  network(network),
  node(node)
- {}
+ {
+ openapi_info.title = "CCF Public Node API";
+ openapi_info.description =
+ "This API provides public, uncredentialed access to service and node "
+ "state.";
+ }
 
  void init_handlers(kv::Store& tables_) override
  {

src/node/rpc/user_frontend.h

@@ -28,7 +28,9 @@ namespace ccf
  h,
  tables.get<ClientSignatures>(Tables::USER_CLIENT_SIGNATURES)),
  users(tables.get<Users>(Tables::USERS))
- {}
+ {
+ h.openapi_info.title = "CCF Application API";
+ }
 
  void open() override
  {