comparison OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4424:83371ccdfe80

openapi documentation is now completed
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 29 Dec 2020 19:28:53 +0100
parents 48303e493135
children d9473bd5ed43
comparison
equal deleted inserted replaced
4423:2a69b58ff3ac 4424:83371ccdfe80
1268 .SetSummary("Access raw frame" + std::string(GzipCompression ? " (compressed)" : "")) 1268 .SetSummary("Access raw frame" + std::string(GzipCompression ? " (compressed)" : ""))
1269 .SetDescription("Access the raw content of one individual frame of the DICOM instance of interest, " 1269 .SetDescription("Access the raw content of one individual frame of the DICOM instance of interest, "
1270 "bypassing image decoding. This is notably useful to access the source files " 1270 "bypassing image decoding. This is notably useful to access the source files "
1271 "in compressed transfer syntaxes." + 1271 "in compressed transfer syntaxes." +
1272 std::string(GzipCompression ? " The image is compressed using gzip" : "")) 1272 std::string(GzipCompression ? " The image is compressed using gzip" : ""))
1273 .SetUriArgument("id", "Orthanc identifier of the instance of interest")
1273 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)"); 1274 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
1274 1275
1275 if (GzipCompression) 1276 if (GzipCompression)
1276 { 1277 {
1277 call.GetDocumentation().AddAnswerType(MimeType_Gzip, "The raw frame, compressed using gzip"); 1278 call.GetDocumentation().AddAnswerType(MimeType_Gzip, "The raw frame, compressed using gzip");
2915 Register("/instances/{id}/export", ExportInstanceFile); 2916 Register("/instances/{id}/export", ExportInstanceFile);
2916 Register("/instances/{id}/tags", GetInstanceTagsBis); 2917 Register("/instances/{id}/tags", GetInstanceTagsBis);
2917 Register("/instances/{id}/simplified-tags", GetInstanceTags<DicomToJsonFormat_Human>); 2918 Register("/instances/{id}/simplified-tags", GetInstanceTags<DicomToJsonFormat_Human>);
2918 Register("/instances/{id}/frames", ListFrames); 2919 Register("/instances/{id}/frames", ListFrames);
2919 2920
2921 Register("/instances/{id}/frames/{frame}", RestApi::AutoListChildren);
2920 Register("/instances/{id}/frames/{frame}/preview", GetImage<ImageExtractionMode_Preview>); 2922 Register("/instances/{id}/frames/{frame}/preview", GetImage<ImageExtractionMode_Preview>);
2921 Register("/instances/{id}/frames/{frame}/rendered", GetRenderedFrame); 2923 Register("/instances/{id}/frames/{frame}/rendered", GetRenderedFrame);
2922 Register("/instances/{id}/frames/{frame}/image-uint8", GetImage<ImageExtractionMode_UInt8>); 2924 Register("/instances/{id}/frames/{frame}/image-uint8", GetImage<ImageExtractionMode_UInt8>);
2923 Register("/instances/{id}/frames/{frame}/image-uint16", GetImage<ImageExtractionMode_UInt16>); 2925 Register("/instances/{id}/frames/{frame}/image-uint16", GetImage<ImageExtractionMode_UInt16>);
2924 Register("/instances/{id}/frames/{frame}/image-int16", GetImage<ImageExtractionMode_Int16>); 2926 Register("/instances/{id}/frames/{frame}/image-int16", GetImage<ImageExtractionMode_Int16>);