From eb36562401d06e0a88214dc87264c90842e62119 Mon Sep 17 00:00:00 2001
From: Hamid Reza Mohammadi <mohammadi.hr@gmail.com>
Date: Wed, 6 Apr 2022 20:20:45 +0430
Subject: [PATCH] docs: #306 api for extracting sections

---
 RMuseum/Controllers/GanjoorController.cs      | 17 +++++++++++++++
 RMuseum/RMuseum.xml                           | 21 +++++++++++++++++++
 RMuseum/Services/IGanjoorService.cs           |  8 +++++++
 .../GanjoorService-PoemSections.cs            |  5 +++++
 4 files changed, 51 insertions(+)

diff --git a/RMuseum/Controllers/GanjoorController.cs b/RMuseum/Controllers/GanjoorController.cs
index 28e80c9a..cdd23bf4 100644
--- a/RMuseum/Controllers/GanjoorController.cs
+++ b/RMuseum/Controllers/GanjoorController.cs
@@ -2748,6 +2748,23 @@ namespace RMuseum.Controllers
             return Ok();
         }
 
+        /// <summary>
+        /// sectionizing poems
+        /// </summary>
+        /// <param name="clearOldSections"></param>
+        /// <returns></returns>
+        [HttpPost("sections/onetime/startextracting")]
+        [Authorize(Policy = RMuseumSecurableItem.GanjoorEntityShortName + ":" + SecurableItem.ModifyOperationShortName)]
+        [ProducesResponseType((int)HttpStatusCode.OK)]
+        [ProducesResponseType((int)HttpStatusCode.BadRequest, Type = typeof(string))]
+        public IActionResult StartSectionizingPoems(bool clearOldSections = false)
+        {
+            var res = _ganjoorService.StartSectionizingPoems(clearOldSections);
+            if (!string.IsNullOrEmpty(res.ExceptionString))
+                return BadRequest(res.ExceptionString);
+            return Ok();
+        }
+
         /// <summary>
         /// readonly mode
         /// </summary>
diff --git a/RMuseum/RMuseum.xml b/RMuseum/RMuseum.xml
index cdc9dfb0..14204242 100644
--- a/RMuseum/RMuseum.xml
+++ b/RMuseum/RMuseum.xml
@@ -1688,6 +1688,13 @@
             <param name="destCatId"></param>
             <returns></returns>
         </member>
+        <member name="M:RMuseum.Controllers.GanjoorController.StartSectionizingPoems(System.Boolean)">
+            <summary>
+            sectionizing poems
+            </summary>
+            <param name="clearOldSections"></param>
+            <returns></returns>
+        </member>
         <member name="P:RMuseum.Controllers.GanjoorController.ReadOnlyMode">
             <summary>
             readonly mode
@@ -11624,6 +11631,13 @@
             <param name="destCatId"></param>
             <returns></returns>
         </member>
+        <member name="M:RMuseum.Services.IGanjoorService.StartSectionizingPoems(System.Boolean)">
+            <summary>
+            sectionizing poems
+            </summary>
+            <param name="clearOldSections"></param>
+            <returns></returns>
+        </member>
         <member name="T:RMuseum.Services.IGanjoorTranslationService">
             <summary>
             translation service implementation
@@ -13210,6 +13224,13 @@
             <param name="rejectionCause"></param>
             <returns></returns>
         </member>
+        <member name="M:RMuseum.Services.Implementation.GanjoorService.StartSectionizingPoems(System.Boolean)">
+            <summary>
+            sectionizing poems
+            </summary>
+            <param name="clearOldSections"></param>
+            <returns></returns>
+        </member>
         <member name="M:RMuseum.Services.Implementation.GanjoorService.StartFindingMissingRhythms(System.Boolean,System.Int32)">
             <summary>
             Start finding missing rhthms
diff --git a/RMuseum/Services/IGanjoorService.cs b/RMuseum/Services/IGanjoorService.cs
index f58cf7f0..d8711d13 100644
--- a/RMuseum/Services/IGanjoorService.cs
+++ b/RMuseum/Services/IGanjoorService.cs
@@ -901,5 +901,13 @@ namespace RMuseum.Services
         /// <param name="destCatId"></param>
         /// <returns></returns>
         RServiceResult<bool> StartRemovingCategoryDuplicates(int catId, int destCatId);
+
+
+        /// <summary>
+        /// sectionizing poems
+        /// </summary>
+        /// <param name="clearOldSections"></param>
+        /// <returns></returns>
+        RServiceResult<bool> StartSectionizingPoems(bool clearOldSections = false);
     }
 }
diff --git a/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-PoemSections.cs b/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-PoemSections.cs
index 17e5f793..38392809 100644
--- a/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-PoemSections.cs
+++ b/RMuseum/Services/Implementation/GanjoorService-Partials/GanjoorService-PoemSections.cs
@@ -16,6 +16,11 @@ namespace RMuseum.Services.Implementation
     /// </summary>
     public partial class GanjoorService : IGanjoorService
     {
+        /// <summary>
+        /// sectionizing poems
+        /// </summary>
+        /// <param name="clearOldSections"></param>
+        /// <returns></returns>
         public RServiceResult<bool> StartSectionizingPoems(bool clearOldSections = false)
         {
             try