docs: Refine documentation for Stack and Variants models, correcting terminology and enhancing clarity for method descriptions.

Author: nadeem-cs

Contentstack.Management.Core/Models/Stack.cs

@@ -622,7 +622,7 @@ public ContentType ContentType(string uid = null)
             return new ContentType(this, uid);
         }
         /// <summary>
-        /// <see cref="Models.Asset"/> efer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use. 
+        /// <see cref="Models.Asset"/> refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use. 
         /// </summary>
         /// <param name="uid">Optional asset uid.</param>
         /// <example>
@@ -762,7 +762,7 @@ public ManagementToken ManagementTokens(string uid = null)
         }
 
         /// <summary>
-        /// A <see cref="Models.Role" /> collection of permissions that will be applicable to all the users who are assigned this role.
+        /// A <see cref="Models.Role" /> is a collection of permissions that will be applicable to all the users who are assigned this role.
         /// </summary>
         /// <param name="uid">Optional, role uid.</param>
         /// <example>
@@ -772,7 +772,7 @@ public ManagementToken ManagementTokens(string uid = null)
         /// ContentstackResponse contentstackResponse = stack.Role("<ROLE_UID>").Fetch();
         /// </code></pre>
         /// </example>
-        /// <returns>The <see cref="Models.Release" /></returns>
+        /// <returns>The <see cref="Models.Role" /></returns>
         public Role Role(string uid = null)
         {
             ThrowIfNotLoggedIn();
@@ -843,17 +843,17 @@ public PublishQueue PublishQueue(string uid = null)
             return new PublishQueue(this, uid);
         }
         /// <summary>
-        /// A <see cref="Models.Webhook" /> a mechanism that sends real-time information to any third-party app or service to keep your application in sync with your Contentstack account. 
+        /// A <see cref="Models.Webhook" /> is a mechanism that sends real-time information to any third-party app or service to keep your application in sync with your Contentstack account. 
         /// </summary>
-        /// <param name="uid">Optional, webhook uid uid.</param>
+        /// <param name="uid">Optional, webhook uid.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
         /// Stack stack = client.Stack("<API_KEY>");
         /// ContentstackResponse contentstackResponse = stack.Webhook("<WEBHOOK_UID>").Fetch();
         /// </code></pre>
         /// </example>
-        /// <returns>The <see cref="Models.AuditLog" /></returns>
+        /// <returns>The <see cref="Models.Webhook" /></returns>
         public Webhook Webhook(string uid = null)
         {
             ThrowIfNotLoggedIn();
@@ -913,24 +913,14 @@ public BulkOperation BulkOperation()
         }
 
         /// <summary>
-        /// Gets the bulk operation instance for performing bulk operations on entries and assets.
+        /// A <see cref="Models.Variants" /> represents different versions or variations of content entries that allow you to create and manage multiple variants of the same content.
         /// </summary>
+        /// <param name="uid">Optional, variant uid.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
         /// Stack stack = client.Stack("<API_KEY>");
-        /// 
-        /// var publishDetails = new BulkPublishDetails
-        /// {
-        ///     Entries = new List<BulkPublishEntry>
-        ///     {
-        ///         new BulkPublishEntry { Uid = "entry_uid", ContentTypeUid = "content_type_uid", Locale = "en-us" }
-        ///     },
-        ///     Locales = new List<string> { "en-us" },
-        ///     Environments = new List<string> { "environment_uid" }
-        /// };
-        /// 
-        /// ContentstackResponse response = stack.BulkOperation().Publish(publishDetails);
+        /// ContentstackResponse contentstackResponse = stack.Variants("<VARIANT_UID>").Fetch();
         /// </code></pre>
         /// </example>
         /// <returns>The <see cref="Models.Variants"/></returns>

Contentstack.Management.Core/Models/Variants.cs

@@ -24,16 +24,15 @@ internal Variants(Stack stack, string uid = null)
         }
 
         /// <summary>
-        /// The Delete variants call is used to delete a specific variants.
+        /// The Delete call is used to delete a specific variant.
         /// </summary>
-        /// <param name="collection">Query parameter</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
-        /// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Variants("<Variants_UID>").Delete();
+        /// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Variants("<VARIANT_UID>").Delete();
         /// </code></pre>
         /// </example>
-        /// <returns>The <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The <see cref="ContentstackResponse"/> containing the deletion result.</returns>
         public virtual ContentstackResponse Delete()
         {
             stack.ThrowIfNotLoggedIn();
@@ -44,16 +43,15 @@ public virtual ContentstackResponse Delete()
         }
 
         /// <summary>
-        /// The Delete variants call is used to delete a specific variants.
+        /// The DeleteAsync call is used to asynchronously delete a specific variant.
         /// </summary>
-        /// <param name="collection">Query parameter</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
-        /// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Variants("<Variants_UID>").DeleteAsync();
+        /// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Variants("<VARIANT_UID>").DeleteAsync();
         /// </code></pre>
         /// </example>
-        /// <returns>The <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The Task containing <see cref="ContentstackResponse"/> with the deletion result.</returns>
         public virtual Task<ContentstackResponse> DeleteAsync()
         {
             stack.ThrowIfNotLoggedIn();
@@ -64,16 +62,16 @@ public virtual Task<ContentstackResponse> DeleteAsync()
         }
 
         /// <summary>
-        /// Retrieves a specific variant by UID.
+        /// The Fetch call retrieves a specific variant by UID.
         /// </summary>
         /// <param name="collection">Optional query parameters.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
-        /// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Variants("<Variants_UID>").Fetch();
+        /// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Variants("<VARIANT_UID>").Fetch();
         /// </code></pre>
         /// </example>
-        /// <returns>Variant data in <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The <see cref="ContentstackResponse"/> containing the variant data.</returns>
         public virtual ContentstackResponse Fetch(ParameterCollection collection = null)
         {
             stack.ThrowIfNotLoggedIn();
@@ -84,16 +82,16 @@ public virtual ContentstackResponse Fetch(ParameterCollection collection = null)
         }
 
         /// <summary>
-        /// Asynchronously retrieves a specific variant by UID.
+        /// The FetchAsync call asynchronously retrieves a specific variant by UID.
         /// </summary>
         /// <param name="collection">Optional query parameters.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
-        /// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Variants("<Variants_UID>").FetchAsync();
+        /// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Variants("<VARIANT_UID>").FetchAsync();
         /// </code></pre>
         /// </example>
-        /// <returns>Task containing variant data in <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The Task containing <see cref="ContentstackResponse"/> with the variant data.</returns>
         public virtual Task<ContentstackResponse> FetchAsync(ParameterCollection collection = null)
         {
             stack.ThrowIfNotLoggedIn();
@@ -104,17 +102,17 @@ public virtual Task<ContentstackResponse> FetchAsync(ParameterCollection collect
         }
 
         /// <summary>
-        /// The Create is used to create an entry variant in the stack.
+        /// The Create call is used to create an entry variant in the stack.
         /// </summary>
-        /// <param name="model"><see cref="VariantsModel"/> with details.</param>
+        /// <param name="model">The <see cref="VariantsModel"/> containing variant details.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
         /// VariantsModel model = new VariantsModel(); 
         /// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Variants().Create(model);
         /// </code></pre>
         /// </example>
-        /// <returns>The <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The <see cref="ContentstackResponse"/> containing the created variant data.</returns>
         public virtual ContentstackResponse Create(VariantsModel model)
         {
             ThrowIfUidNotEmpty();
@@ -124,17 +122,17 @@ public virtual ContentstackResponse Create(VariantsModel model)
         }
 
         /// <summary>
-        /// The Create is used to create an entry variant in the stack.
+        /// The CreateAsync call is used to asynchronously create an entry variant in the stack.
         /// </summary>
-        /// <param name="model"><see cref="VariantsModel"/> with details.</param>
+        /// <param name="model">The <see cref="VariantsModel"/> containing variant details.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
         /// VariantsModel model = new VariantsModel();
         /// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Variants().CreateAsync(model);
         /// </code></pre>
         /// </example>
-        /// <returns>The Task.</returns>
+        /// <returns>The Task containing <see cref="ContentstackResponse"/> with the created variant data.</returns>
         public virtual Task<ContentstackResponse> CreateAsync(VariantsModel model)
         {
             ThrowIfUidNotEmpty();
@@ -145,17 +143,18 @@ public virtual Task<ContentstackResponse> CreateAsync(VariantsModel model)
         }
 
         /// <summary>
-        /// Retrieves multiple variants by their UIDs.
+        /// The FetchByUid call retrieves multiple variants by passing an array of their UIDs.
+        /// This method allows you to fetch multiple variants in a single API call.
         /// </summary>
-        /// <param name="uids">Array of variant UIDs to fetch.</param>
+        /// <param name="uids">Array of variant UIDs to fetch. Cannot be null or empty.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
-        /// string[] variantUids = {"uid1", "uid2", "uid3"};
+        /// string[] variantUids = {"bltvariant123", "bltvariant456", "bltvariant789"};
         /// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Variants().FetchByUid(variantUids);
         /// </code></pre>
         /// </example>
-        /// <returns>Variants data in <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The <see cref="ContentstackResponse"/> containing the requested variants data.</returns>
         public virtual ContentstackResponse FetchByUid(string[] uids)
         {
             stack.ThrowIfNotLoggedIn();
@@ -174,17 +173,18 @@ public virtual ContentstackResponse FetchByUid(string[] uids)
         }
 
         /// <summary>
-        /// Asynchronously retrieves multiple variants by their UIDs.
+        /// The FetchByUidAsync call asynchronously retrieves multiple variants by passing an array of their UIDs.
+        /// This method allows you to fetch multiple variants in a single API call asynchronously.
         /// </summary>
-        /// <param name="uids">Array of variant UIDs to fetch.</param>
+        /// <param name="uids">Array of variant UIDs to fetch. Cannot be null or empty.</param>
         /// <example>
         /// <pre><code>
         /// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
-        /// string[] variantUids = {"uid1", "uid2", "uid3"};
+        /// string[] variantUids = {"bltvariant123", "bltvariant456", "bltvariant789"};
         /// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Variants().FetchByUidAsync(variantUids);
         /// </code></pre>
         /// </example>
-        /// <returns>Task containing variants data in <see cref="ContentstackResponse"/>.</returns>
+        /// <returns>The Task containing <see cref="ContentstackResponse"/> with the requested variants data.</returns>
         public virtual Task<ContentstackResponse> FetchByUidAsync(string[] uids)
         {
             stack.ThrowIfNotLoggedIn();