mint: annotate post_swap for Swagger UI

crates/cdk-axum/src/lib.rs

@@ -17,6 +17,7 @@ use cdk::nuts::nut00::{
 };
 use cdk::nuts::nut01::{Keys, KeysResponse, PublicKey, SecretKey};
 use cdk::nuts::nut02::{Id, KeySet, KeySetInfo, KeySetVersion, KeysetResponse};
+use cdk::nuts::nut03::{SwapRequest, SwapResponse};
 use cdk::nuts::nut04;
 use cdk::nuts::nut04::{
     MintBolt11Request, MintBolt11Response, MintMethodSettings, MintQuoteBolt11Request,
@@ -88,6 +89,8 @@ pub struct MintState {
         PublicKey,
         SecretKey,
         SupportedSettings,
+        SwapRequest,
+        SwapResponse,
         Witness,
         nut04::Settings,
         nut05::Settings,
@@ -104,7 +107,8 @@ pub struct MintState {
         post_mint_bolt11,
         get_melt_bolt11_quote,
         get_check_melt_bolt11_quote,
-        post_melt_bolt11
+        post_melt_bolt11,
+        post_swap
     )
 )]
 /// OpenAPI spec for the mint's v1 APIs

crates/cdk-axum/src/router_handlers.rs

@@ -311,6 +311,21 @@ pub async fn get_mint_info(State(state): State<MintState>) -> Result<Json<MintIn
     Ok(Json(state.mint.mint_info().clone().time(unix_time())))
 }
 
+#[utoipa::path(
+    post,
+    context_path = "/v1",
+    path = "/swap",
+    request_body(content = SwapRequest, description = "Swap params", content_type = "application/json"),
+    responses(
+        (status = 200, description = "Successful response", body = SwapResponse, content_type = "application/json"),
+        (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
+    )
+)]
+/// Swap inputs for outputs of the same value
+///
+/// Requests a set of Proofs to be swapped for another set of BlindSignatures.
+///
+/// This endpoint can be used by Alice to swap a set of proofs before making a payment to Carol. It can then used by Carol to redeem the tokens for new proofs.
 pub async fn post_swap(
     State(state): State<MintState>,
     Json(payload): Json<SwapRequest>,

crates/cdk/src/nuts/nut03.rs

@@ -34,8 +34,10 @@ pub struct PreSwap {
 
 /// Split Request [NUT-06]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "mint", derive(utoipa::ToSchema))]
 pub struct SwapRequest {
     /// Proofs that are to be spent in `Split`
+    #[cfg_attr(feature = "mint", schema(value_type = Vec<Proof>))]
     pub inputs: Proofs,
     /// Blinded Messages for Mint to sign
     pub outputs: Vec<BlindedMessage>,
@@ -64,6 +66,7 @@ impl SwapRequest {
 
 /// Split Response [NUT-06]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "mint", derive(utoipa::ToSchema))]
 pub struct SwapResponse {
     /// Promises
     pub signatures: Vec<BlindSignature>,