mycelium-api 8.3.1-rc.1

Provide API ports to the mycelium project.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

use super::config::OpenRpcSpecConfig;
use super::methods;
use super::schema;

const OPENRPC_VERSION: &str = "1.2.6";
const API_VERSION: &str = env!("CARGO_PKG_VERSION");

/// Build the OpenRPC spec document for the admin JSON-RPC API.
pub fn generate_openrpc_spec(config: &OpenRpcSpecConfig) -> serde_json::Value {
    let mut servers = vec![serde_json::json!({
        "name": "Development",
        "url": config.dev_url,
        "summary": "Local or development server"
    })];

    if let Some(ref url) = config.prod_url {
        servers.push(serde_json::json!({
            "name": "Production",
            "url": url,
            "summary": "Production server"
        }));
    }

    let methods = methods::all_methods();

    let mut spec = serde_json::json!({
        "openrpc": OPENRPC_VERSION,
        "info": {
            "title": "Mycelium Admin JSON-RPC API",
            "description": "JSON-RPC 2.0 API for Mycelium admin operations (managers). Supports single request and batch. Scope and permission checks are enforced by use cases.",
            "version": API_VERSION,
            "contact": {
                "name": "Samuel Galvão Elias",
                "url": "https://github.com/sgelias/mycelium"
            }
        },
        "servers": servers,
        "methods": methods,
        "components": { "schemas": {} }
    });

    schema::ensure_schema_safe_for_openrpc_generator(&mut spec);
    spec
}