From 09f8edcbbfc04d9373d57be11a79da180be7d033 Mon Sep 17 00:00:00 2001
From: Kevin Pease <kevin@baseflow.com>
Date: Tue, 4 Jun 2024 11:14:41 +0200
Subject: [PATCH] Add documentation

---
 .../src/models/response_models.rs             | 27 ++++++++++++++-----
 1 file changed, 21 insertions(+), 6 deletions(-)

diff --git a/stellar_rust_sdk/src/models/response_models.rs b/stellar_rust_sdk/src/models/response_models.rs
index 5aa88e4..a151481 100644
--- a/stellar_rust_sdk/src/models/response_models.rs
+++ b/stellar_rust_sdk/src/models/response_models.rs
@@ -1,6 +1,10 @@
 use crate::Getters;
 use serde::{Deserialize, Serialize};
 
+/// Represents the navigational links in a response.
+///
+/// Contains the links to the current, next, and previous pages of the response.
+/// 
 #[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
 pub struct ResponseLinks {
     #[serde(rename = "self")]
@@ -9,22 +13,33 @@ pub struct ResponseLinks {
     pub prev: Option<Link>,
 }
 
+/// Represents a navigational link in a response.
+///
+/// Contains an optional url.
+/// 
 #[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
 pub struct Link {
     pub href: Option<String>,
 }
 
-#[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
-pub struct Embedded<T> {
-    pub records: Vec<T>,
-}
-
+/// Represents a navigational link in a response.
+///
+/// Contains an optional url, and an optional boolean to indicate whether a link is templated or not.
+/// 
 #[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
 pub struct TemplateLink {
     pub href: Option<String>,
     pub templated: Option<bool>,
 }
 
+/// Represents a collection of results in a response. 
+/// 
+/// Contains a vector, which can hold any type of record returned by the API.
+#[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
+pub struct Embedded<T> {
+    pub records: Vec<T>,
+}
+
 /// Represents the authorization and control flags for an asset in the all assets response.
 ///
 /// Details the various boolean flags that are
@@ -45,4 +60,4 @@ pub struct Flags {
     /// A `bool` indicating whether the asset supports the clawback operation.
     ///   If `true`, the issuer can claw back the asset from user accounts.
     auth_clawback_enabled: bool,
-}
+}
\ No newline at end of file