Extend swagger docs (#5235)

* WIP adding derive(ToSchema)

* Derive ToSchema for more types

* ContractBuildInformation on /nym_contracts_detailed

* rustfmt

* Add cfg_attr

* A bunch of annotations

* Compiles with utoipa 5.2

* WIP

* Post rebase fixes

* Gitattributes to ignore .sqlx diffs

* generate Sqlx schema files

* Improvements

* Move ecash schema out of ecash crate

* Move redocly config to nym-api/

* Move redocly config to nym-api/

* Remove ErrorResponse

* Move generated openapi spec to .gitignore

* Include BSL licence

* Remove utoipa from ecash toml file

* Remove placeholder annotations

* Chain-watcher rebase changes

* Update licence info

* Treat Scalar as String in OpenAPI

nym-api/src/node_status_api/handlers/without_monitor.rs

@@ -1,6 +1,8 @@
 // Copyright 2021-2024 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: GPL-3.0-only
 
+// we want to mark the routes as deprecated in swagger, but still expose them
+#![allow(deprecated)]
 use crate::node_status_api::handlers::MixIdParam;
 use crate::node_status_api::helpers::{
     _get_active_set_legacy_mixnodes_detailed, _get_legacy_mixnodes_detailed,
@@ -20,8 +22,6 @@ use nym_mixnet_contract_common::NodeId;
 use nym_types::monitoring::MonitorMessage;
 use tracing::error;
 
-// we want to mark the routes as deprecated in swagger, but still expose them
-#[allow(deprecated)]
 pub(super) fn mandatory_routes() -> Router<AppState> {
     Router::new()
         .route(
@@ -63,9 +63,9 @@ pub(super) fn mandatory_routes() -> Router<AppState> {
     path = "/v1/status/submit-gateway-monitoring-results",
     responses(
         (status = 200),
-        (status = 400, body = ErrorResponse, description = "TBD"),
-        (status = 403, body = ErrorResponse, description = "TBD"),
-        (status = 500, body = ErrorResponse, description = "TBD"),
+        (status = 400, body = String, description = "TBD"),
+        (status = 403, body = String, description = "TBD"),
+        (status = 500, body = String, description = "TBD"),
     ),
 )]
 pub(crate) async fn submit_gateway_monitoring_results(
@@ -107,9 +107,9 @@ pub(crate) async fn submit_gateway_monitoring_results(
     path = "/v1/status/submit-node-monitoring-results",
     responses(
         (status = 200),
-        (status = 400, body = ErrorResponse, description = "TBD"),
-        (status = 403, body = ErrorResponse, description = "TBD"),
-        (status = 500, body = ErrorResponse, description = "TBD"),
+        (status = 400, body = String, description = "TBD"),
+        (status = 403, body = String, description = "TBD"),
+        (status = 500, body = String, description = "TBD"),
     ),
 )]
 pub(crate) async fn submit_node_monitoring_results(
@@ -198,7 +198,7 @@ async fn get_mixnode_stake_saturation(
     ),
     path = "/v1/status/mixnode/{mix_id}/inclusion-probability",
     responses(
-        (status = 200, body = InclusionProbabilityResponse)
+        (status = 200, body = nym_api_requests::models::InclusionProbabilityResponse)
     )
 )]
 #[deprecated]
@@ -217,7 +217,7 @@ async fn get_mixnode_inclusion_probability(
     get,
     path = "/v1/status/mixnodes/inclusion-probability",
     responses(
-        (status = 200, body = AllInclusionProbabilitiesResponse)
+        (status = 200, body = nym_api_requests::models::AllInclusionProbabilitiesResponse)
     )
 )]
 #[deprecated]

nym-api/src/node_status_api/models.rs

@@ -22,6 +22,7 @@ use std::fmt::Display;
 use thiserror::Error;
 use time::{Date, OffsetDateTime};
 use tracing::error;
+use utoipa::ToSchema;
 
 #[derive(Error, Debug)]
 #[error("Received uptime value was within 0-100 range (got {received})")]
@@ -128,14 +129,17 @@ impl From<Uptime> for Performance {
     }
 }
 
-#[derive(Clone, Serialize, Deserialize, Debug, JsonSchema)]
+#[derive(Clone, Serialize, Deserialize, Debug, JsonSchema, ToSchema)]
 pub struct MixnodeStatusReport {
+    #[schema(value_type = u32)]
     pub(crate) mix_id: NodeId,
+    #[schema(value_type = String)]
     pub(crate) identity: IdentityKey,
-
+    #[schema(value_type = u8)]
     pub(crate) most_recent: Uptime,
-
+    #[schema(value_type = u8)]
     pub(crate) last_hour: Uptime,
+    #[schema(value_type = u8)]
     pub(crate) last_day: Uptime,
 }
 
@@ -315,8 +319,12 @@ impl From<HistoricalUptime> for OldHistoricalUptimeResponse {
 
 // TODO rocket remove smurf name after eliminating `rocket`
 pub(crate) type AxumResult<T> = Result<T, AxumErrorResponse>;
+
+// #[derive(ToSchema, ToResponse)]
+// #[schema(title = "ErrorResponse")]
 pub(crate) struct AxumErrorResponse {
     message: RequestError,
+    // #[schema(value_type = u16)]
     status: StatusCode,
 }