changeset 5931:7f0145ff63f3

fix documentation of /tools/find
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 16 Dec 2024 17:25:20 +0100
parents 6530bc38782f
children 8a500c0defbf
files OrthancServer/Sources/OrthancRestApi/OrthancRestApi.cpp OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp
diffstat 2 files changed, 2 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestApi.cpp	Mon Dec 16 17:04:35 2024 +0100
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestApi.cpp	Mon Dec 16 17:25:20 2024 +0100
@@ -711,7 +711,7 @@
                             "(new in Orthanc 1.12.5 - overrides `expand`)", false);
 
       call.GetDocumentation().SetHttpGetArgument(GET_EXPAND, RestApiCallDocumentation::Type_String,
-                            "If present, retrieve detailed information about the individual resources", false);
+                            "If present, retrieve detailed information about the individual resources, not only their Orthanc identifiers", false);
 
     }
     else if (call.GetMethod() == HttpMethod_Post)
@@ -724,7 +724,7 @@
                             "(new in Orthanc 1.12.5)", false);
 
       call.GetDocumentation().SetRequestField(POST_EXPAND, RestApiCallDocumentation::Type_Boolean,
-                            "If present, retrieve detailed information about the individual resources", false);
+                            "If set to \"true\", retrieve detailed information about the individual resources, not only their Orthanc identifiers", false);
     }
     else
     {
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Mon Dec 16 17:04:35 2024 +0100
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Mon Dec 16 17:25:20 2024 +0100
@@ -3127,8 +3127,6 @@
           .SetDescription("This URI can be used to perform a search on the content of the local Orthanc server, "
                           "in a way that is similar to querying remote DICOM modalities using C-FIND SCU: "
                           "https://orthanc.uclouvain.be/book/users/rest.html#performing-finds-within-orthanc")
-          .SetRequestField(KEY_EXPAND, RestApiCallDocumentation::Type_Boolean,
-                          "Also retrieve the content of the matching resources, not only their Orthanc identifiers", false)
           .SetRequestField(KEY_LIMIT, RestApiCallDocumentation::Type_Number,
                           "Limit the number of reported resources", false)
           .SetRequestField(KEY_SINCE, RestApiCallDocumentation::Type_Number,