Merge pull request #27 from G8XSU/response-docs

Add docs for API response objects.

Author: G8XSU

ldk-server-protos/src/api.rs

@@ -5,6 +5,8 @@
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct GetNodeInfoRequest {}
+/// The response `content` for the `GetNodeInfo` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct GetNodeInfoResponse {
@@ -50,6 +52,8 @@ pub struct GetNodeInfoResponse {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct OnchainReceiveRequest {}
+/// The response `content` for the `OnchainReceive` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`..
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct OnchainReceiveResponse {
@@ -80,6 +84,8 @@ pub struct OnchainSendRequest {
 	#[prost(bool, optional, tag = "3")]
 	pub send_all: ::core::option::Option<bool>,
 }
+/// The response `content` for the `OnchainSend` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct OnchainSendResponse {
@@ -107,6 +113,8 @@ pub struct Bolt11ReceiveRequest {
 	#[prost(uint32, tag = "3")]
 	pub expiry_secs: u32,
 }
+/// The response `content` for the `Bolt11Receive` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt11ReceiveResponse {
@@ -130,6 +138,8 @@ pub struct Bolt11SendRequest {
 	#[prost(uint64, optional, tag = "2")]
 	pub amount_msat: ::core::option::Option<u64>,
 }
+/// The response `content` for the `Bolt11Send` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt11SendResponse {
@@ -159,6 +169,8 @@ pub struct Bolt12ReceiveRequest {
 	#[prost(uint64, optional, tag = "4")]
 	pub quantity: ::core::option::Option<u64>,
 }
+/// The response `content` for the `Bolt12Receive` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt12ReceiveResponse {
@@ -190,6 +202,8 @@ pub struct Bolt12SendRequest {
 	#[prost(string, optional, tag = "4")]
 	pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
 }
+/// The response `content` for the `Bolt12Send` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt12SendResponse {
@@ -222,6 +236,8 @@ pub struct OpenChannelRequest {
 	#[prost(bool, tag = "6")]
 	pub announce_channel: bool,
 }
+/// The response `content` for the `OpenChannel` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct OpenChannelResponse {
@@ -244,6 +260,8 @@ pub struct UpdateChannelConfigRequest {
 	#[prost(message, optional, tag = "3")]
 	pub channel_config: ::core::option::Option<super::types::ChannelConfig>,
 }
+/// The response `content` for the `UpdateChannelConfig` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct UpdateChannelConfigResponse {}
@@ -267,6 +285,8 @@ pub struct CloseChannelRequest {
 	#[prost(string, optional, tag = "4")]
 	pub force_close_reason: ::core::option::Option<::prost::alloc::string::String>,
 }
+/// The response `content` for the `CloseChannel` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct CloseChannelResponse {}
@@ -275,6 +295,8 @@ pub struct CloseChannelResponse {}
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct ListChannelsRequest {}
+/// The response `content` for the `ListChannels` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct ListChannelsResponse {
@@ -291,6 +313,8 @@ pub struct GetPaymentDetailsRequest {
 	#[prost(string, tag = "1")]
 	pub payment_id: ::prost::alloc::string::String,
 }
+/// The response `content` for the `GetPaymentDetails` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct GetPaymentDetailsResponse {
@@ -304,6 +328,8 @@ pub struct GetPaymentDetailsResponse {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct ListPaymentsRequest {}
+/// The response `content` for the `ListPayments` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct ListPaymentsResponse {
@@ -316,6 +342,8 @@ pub struct ListPaymentsResponse {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct GetBalancesRequest {}
+/// The response `content` for the `GetBalances` API, when HttpStatusCode is OK (200).
+/// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct GetBalancesResponse {

ldk-server-protos/src/proto/api.proto

@@ -10,6 +10,8 @@ import 'types.proto';
 message GetNodeInfoRequest {
 }
 
+// The response `content` for the `GetNodeInfo` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message GetNodeInfoResponse {
 
   // The hex-encoded `node-id` or public key for our own lightning node.
@@ -54,6 +56,8 @@ message GetNodeInfoResponse {
 message OnchainReceiveRequest {
 }
 
+// The response `content` for the `OnchainReceive` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`..
 message OnchainReceiveResponse {
 
   // A Bitcoin on-chain address.
@@ -82,6 +86,8 @@ message OnchainSendRequest {
   optional bool send_all = 3;
 }
 
+// The response `content` for the `OnchainSend` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message OnchainSendResponse {
 
   // The transaction ID of the broadcasted transaction.
@@ -107,7 +113,8 @@ message Bolt11ReceiveRequest {
   uint32 expiry_secs = 3;
 }
 
-
+// The response `content` for the `Bolt11Receive` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message Bolt11ReceiveResponse {
 
   // An invoice for a payment within the Lightning Network.
@@ -130,6 +137,8 @@ message Bolt11SendRequest {
 
 }
 
+// The response `content` for the `Bolt11Send` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message Bolt11SendResponse {
 
   // An identifier used to uniquely identify a payment.
@@ -157,6 +166,8 @@ message Bolt12ReceiveRequest {
   optional uint64 quantity = 4;
 }
 
+// The response `content` for the `Bolt12Receive` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message Bolt12ReceiveResponse {
 
   // An offer for a payment within the Lightning Network.
@@ -186,6 +197,8 @@ message Bolt12SendRequest {
   optional string payer_note = 4;
 }
 
+// The response `content` for the `Bolt12Send` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message Bolt12SendResponse {
 
   // An identifier used to uniquely identify a payment.
@@ -216,6 +229,8 @@ message OpenChannelRequest {
   bool announce_channel = 6;
 }
 
+// The response `content` for the `OpenChannel` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message OpenChannelResponse {
 
   // The channel id of the created channel that user can use to refer to channel.
@@ -236,6 +251,8 @@ message UpdateChannelConfigRequest {
   types.ChannelConfig channel_config = 3;
 }
 
+// The response `content` for the `UpdateChannelConfig` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message UpdateChannelConfigResponse {
 }
 
@@ -258,6 +275,8 @@ message CloseChannelRequest {
   optional string force_close_reason = 4;
 }
 
+// The response `content` for the `CloseChannel` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message CloseChannelResponse {
 
 }
@@ -266,6 +285,8 @@ message CloseChannelResponse {
 // See more: https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_channels
 message ListChannelsRequest {}
 
+// The response `content` for the `ListChannels` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message ListChannelsResponse {
 
   // List of channels.
@@ -279,6 +300,8 @@ message GetPaymentDetailsRequest {
   string payment_id = 1;
 }
 
+// The response `content` for the `GetPaymentDetails` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message GetPaymentDetailsResponse {
   // Represents a payment.
   // Will be `None` if payment doesn't exist.
@@ -289,6 +312,8 @@ message GetPaymentDetailsResponse {
 // See more: https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments
 message ListPaymentsRequest {}
 
+// The response `content` for the `ListPayments` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message ListPaymentsResponse {
   // List of payments.
   repeated types.Payment payments = 1;
@@ -298,6 +323,8 @@ message ListPaymentsResponse {
 // See more: https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_balances
 message GetBalancesRequest {}
 
+// The response `content` for the `GetBalances` API, when HttpStatusCode is OK (200).
+// When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message GetBalancesResponse {
   // The total balance of our on-chain wallet.
   uint64 total_onchain_balance_sats = 1;