Mercurial > hg > orthanc

diff OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 5467:68e9f7815fb8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clarified recycle/reject + protection
author Alain Mazy <am@osimis.io>
date Mon, 18 Dec 2023 09:52:12 +0100
parents 912565317b9a
children 48b8dae6dc77
line wrap: on
line diff
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Tue Dec 12 14:24:30 2023 +0100
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Mon Dec 18 09:52:12 2023 +0100
@@ -342,8 +342,10 @@
     {
       call.GetDocumentation()
         .SetTag("Patients")
-        .SetSummary("Protect one patient against recycling")
-        .SetDescription("Check out configuration options `MaximumStorageSize` and `MaximumPatientCount`")
+        .SetSummary("Protect/Unprotect a patient against recycling")
+        .SetDescription("Protects a patient by sending `1` or `true` in the payload request. "
+                        "Unprotects a patient by sending `0` or `false` in the payload requests. "
+                        "More info: https://orthanc.uclouvain.be/book/faq/features.html#recycling-protection")
         .SetUriArgument("id", "Orthanc identifier of the patient of interest");
       return;
     }