Jędrzej Stuczyński
931ec03b28
* feat: expose nym-nodes' on-chain address on v2 auxiliary endpoint * moved swagger page outside the v1 route * fixed swagger endpoint for nym-api * post rebasing fixes * remove redundant impl OfflineSigner for Arc<DirectSecp256k1HdWallet>
114 lines
6.0 KiB
Rust
114 lines
6.0 KiB
Rust
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
use axum::Router;
|
|
use nym_node_requests::api as api_requests;
|
|
use nym_node_requests::routes;
|
|
use utoipa::openapi::security::{Http, HttpAuthScheme};
|
|
use utoipa::{Modify, OpenApi, openapi::security::SecurityScheme};
|
|
use utoipa_swagger_ui::SwaggerUi;
|
|
|
|
#[derive(OpenApi)]
|
|
#[openapi(
|
|
info(title = "NymNode API"),
|
|
paths(
|
|
crate::node::http::router::api::v1::metrics::verloc::verloc_stats,
|
|
crate::node::http::router::api::v1::metrics::legacy_mixing::legacy_mixing_stats,
|
|
crate::node::http::router::api::v1::metrics::wireguard::wireguard_stats,
|
|
crate::node::http::router::api::v1::metrics::sessions::sessions_stats,
|
|
crate::node::http::router::api::v1::metrics::packets_stats::packets_stats,
|
|
crate::node::http::router::api::v1::metrics::prometheus::prometheus_metrics,
|
|
crate::node::http::router::api::v1::ip_packet_router::root::root_ip_packet_router,
|
|
crate::node::http::router::api::v1::health::root_health,
|
|
crate::node::http::router::api::v1::network::upgrade_mode::upgrade_mode_status,
|
|
crate::node::http::router::api::v1::mixnode::root::root_mixnode,
|
|
crate::node::http::router::api::v1::load::root_load,
|
|
crate::node::http::router::api::v1::node::host_information::host_information,
|
|
crate::node::http::router::api::v1::node::description::description,
|
|
crate::node::http::router::api::v1::node::roles::roles,
|
|
crate::node::http::router::api::v1::node::auxiliary::auxiliary,
|
|
crate::node::http::router::api::v1::node::build_information::build_information,
|
|
crate::node::http::router::api::v1::node::hardware::host_system,
|
|
crate::node::http::router::api::v1::authenticator::root::root_authenticator,
|
|
crate::node::http::router::api::v1::network_requester::exit_policy::node_exit_policy,
|
|
crate::node::http::router::api::v1::network_requester::root::root_network_requester,
|
|
crate::node::http::router::api::v1::gateway::client_interfaces::client_interfaces,
|
|
crate::node::http::router::api::v1::gateway::client_interfaces::mixnet_websockets,
|
|
crate::node::http::router::api::v1::gateway::client_interfaces::wireguard_details,
|
|
crate::node::http::router::api::v1::gateway::root::root_gateway,
|
|
crate::node::http::router::api::v1::lewes_protocol::root::root_lewes_protocol,
|
|
crate::node::http::router::api::v2::node::auxiliary::auxiliary,
|
|
),
|
|
components(
|
|
schemas(
|
|
nym_http_api_common::Output,
|
|
nym_http_api_common::OutputParams,
|
|
nym_http_api_common::OutputV2,
|
|
nym_http_api_common::OutputParamsV2,
|
|
api_requests::v1::health::models::NodeHealth,
|
|
api_requests::v1::health::models::NodeStatus,
|
|
api_requests::v1::node_load::models::NodeLoad,
|
|
api_requests::v1::node_load::models::Load,
|
|
api_requests::v1::node::models::BinaryBuildInformationOwned,
|
|
api_requests::v1::node::models::HostInformation,
|
|
api_requests::v1::node::models::HostKeys,
|
|
api_requests::v1::node::models::NodeRoles,
|
|
api_requests::v1::node::models::HostSystem,
|
|
api_requests::v1::node::models::Hardware,
|
|
api_requests::v1::node::models::Cpu,
|
|
api_requests::v1::node::models::CryptoHardware,
|
|
api_requests::v1::node::models::NodeDescription,
|
|
api_requests::v1::node::models::AuxiliaryDetailsV1,
|
|
api_requests::v1::metrics::models::LegacyMixingStats,
|
|
api_requests::v1::metrics::models::VerlocStats,
|
|
api_requests::v1::metrics::models::VerlocResult,
|
|
api_requests::v1::metrics::models::VerlocResultData,
|
|
api_requests::v1::metrics::models::VerlocNodeResult,
|
|
api_requests::v1::metrics::models::VerlocMeasurement,
|
|
api_requests::v1::gateway::models::Gateway,
|
|
api_requests::v1::gateway::models::Wireguard,
|
|
api_requests::v1::gateway::models::ClientInterfaces,
|
|
api_requests::v1::gateway::models::WebSockets,
|
|
api_requests::v1::mixnode::models::Mixnode,
|
|
api_requests::v1::network_requester::models::NetworkRequester,
|
|
api_requests::v1::network_requester::exit_policy::models::AddressPolicy,
|
|
api_requests::v1::network_requester::exit_policy::models::AddressPolicyRule,
|
|
api_requests::v1::network_requester::exit_policy::models::AddressPolicyAction,
|
|
api_requests::v1::network_requester::exit_policy::models::AddressPortPattern,
|
|
api_requests::v1::network_requester::exit_policy::models::PortRange,
|
|
api_requests::v1::network_requester::exit_policy::models::UsedExitPolicy,
|
|
api_requests::v1::ip_packet_router::models::IpPacketRouter,
|
|
api_requests::v1::lewes_protocol::models::LewesProtocol,
|
|
api_requests::v2::node::models::AuxiliaryDetailsV2,
|
|
),
|
|
),
|
|
modifiers(&SecurityAddon),
|
|
)]
|
|
pub(crate) struct ApiDoc;
|
|
|
|
struct SecurityAddon;
|
|
|
|
impl Modify for SecurityAddon {
|
|
fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
|
|
if let Some(components) = openapi.components.as_mut() {
|
|
components.add_security_scheme(
|
|
"prometheus_token",
|
|
SecurityScheme::Http(Http::new(HttpAuthScheme::Bearer)),
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
pub(crate) fn route<S: Send + Sync + 'static + Clone>() -> Router<S> {
|
|
// SwaggerUi must be mounted with its absolute path: it emits internal redirects
|
|
// (e.g. `/swagger` → `/swagger/`) whose `Location` header uses this string
|
|
// literally and is not aware of any `.nest()` prefix above it. For the same
|
|
// reason, this router must be merged at the outer router level — not nested.
|
|
let openapi_json = format!("{}/api-docs/openapi.json", routes::API);
|
|
let config = utoipa_swagger_ui::Config::from(openapi_json.clone());
|
|
SwaggerUi::new(routes::api::swagger_absolute())
|
|
.url(openapi_json, ApiDoc::openapi())
|
|
.config(config)
|
|
.into()
|
|
}
|