changeset 4480:d0581d0b22b8

Clarifying documentation of "AllowTranscoding" in "DicomModalities"
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 27 Jan 2021 18:54:21 +0100
parents 1619cffd1948
children fe7c2be5bce2
files OrthancServer/Resources/Configuration.json OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp
diffstat 2 files changed, 7 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/OrthancServer/Resources/Configuration.json	Wed Jan 27 18:37:34 2021 +0100
+++ b/OrthancServer/Resources/Configuration.json	Wed Jan 27 18:54:21 2021 +0100
@@ -330,9 +330,10 @@
      *
      * Starting with Orthanc 1.7.0, "AllowTranscoding" can be used to
      * disable the transcoding to uncompressed transfer syntaxes if
-     * the remote modality doesn't support compressed transfer
-     * syntaxes. This option only has an effect if global option
-     * "EnableTranscoding" is set to "true".
+     * this remote modality doesn't support compressed transfer
+     * syntaxes. This option currently applies to Orthanc C-GET SCP
+     * and to Orthanc C-STORE SCU. This option only has an effect if
+     * the global option "EnableTranscoding" is set to "true".
      *
      * By default, all "Allow*" options are true.
      * "AllowStorageCommitment" is actually an alias for 
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp	Wed Jan 27 18:37:34 2021 +0100
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp	Wed Jan 27 18:54:21 2021 +0100
@@ -141,7 +141,9 @@
         .SetRequestField("AllowStorageCommitment", RestApiCallDocumentation::Type_Boolean,
                          "Whether to accept storage commitment requests issued by the remote modality", false)
         .SetRequestField("AllowTranscoding", RestApiCallDocumentation::Type_Boolean,
-                         "Whether to allow transcoding for operations initiated by this modality (typically, C-GET)", false);
+                         "Whether to allow transcoding for operations initiated by this modality. "
+                         "This option applies to Orthanc C-GET SCP and to Orthanc C-STORE SCU. "
+                         "It only has an effect if the global option `EnableTranscoding` is set to `true`.", false);
     }
   }