comparison OrthancServer/Sources/OrthancRestApi/OrthancRestArchive.cpp @ 4417:a4518adede59

openapi for plugins and jobs
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 28 Dec 2020 17:40:35 +0100
parents 0b27841950d5
children d9473bd5ed43
comparison
equal deleted inserted replaced
4416:0b27841950d5 4417:a4518adede59
212 "transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", false) 212 "transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", false)
213 .SetRequestField("Priority", RestApiCallDocumentation::Type_Number, 213 .SetRequestField("Priority", RestApiCallDocumentation::Type_Number,
214 "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.", false) 214 "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.", false)
215 .AddAnswerType(MimeType_Zip, "In synchronous mode, the ZIP file containing the archive") 215 .AddAnswerType(MimeType_Zip, "In synchronous mode, the ZIP file containing the archive")
216 .AddAnswerType(MimeType_Json, "In asynchronous mode, information about the job that has been submitted to " 216 .AddAnswerType(MimeType_Json, "In asynchronous mode, information about the job that has been submitted to "
217 "generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs"); 217 "generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs")
218 .SetAnswerField("ID", RestApiCallDocumentation::Type_String, "Identifier of the job")
219 .SetAnswerField("Path", RestApiCallDocumentation::Type_String, "Path to access the job in the REST API");
218 220
219 if (isMedia) 221 if (isMedia)
220 { 222 {
221 call.GetDocumentation().SetRequestField( 223 call.GetDocumentation().SetRequestField(
222 KEY_EXTENDED, RestApiCallDocumentation::Type_Boolean, "If `true`, will include additional " 224 KEY_EXTENDED, RestApiCallDocumentation::Type_Boolean, "If `true`, will include additional "