Mercurial > hg > orthanc

annotate OrthancFramework/Sources/RestApi/RestApiCall.h @ 5485:48b8dae6dc77

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
upgrade to year 2024
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 04 Jan 2024 15:10:42 +0100
parents 0ea402b4d901
children f7adfb22e20e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1571
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 978
diff changeset
4 * Department, University Hospital of Liege, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
11 * the License, or (at your option) any later version.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
16 * Lesser General Public License for more details.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
20 * <http://www.gnu.org/licenses/>.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
26 #include "../HttpServer/HttpToolbox.h"
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
27 #include "RestApiCallDocumentation.h"
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include "RestApiPath.h"
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include "RestApiOutput.h"
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
978
ce3106e5843f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 975
diff changeset
31 #include <boost/noncopyable.hpp>
4424
83371ccdfe80 openapi documentation is now completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4412
diff changeset
32 #include <set>
978
ce3106e5843f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 975
diff changeset
33
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 namespace Orthanc
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 class RestApi;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
978
ce3106e5843f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 975
diff changeset
38 class RestApiCall : public boost::noncopyable
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 private:
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 RestApiOutput& output_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 RestApi& context_;
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
43 RequestOrigin origin_;
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
44 const char* remoteIp_;
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
45 const char* username_;
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
46 const HttpToolbox::Arguments& httpHeaders_;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
47 const HttpToolbox::Arguments& uriComponents_;
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 const UriComponents& trailing_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 const UriComponents& fullUri_;
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
50 HttpMethod method_; // To create RestApiCallDocumentation on demand
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
51 std::unique_ptr<RestApiCallDocumentation> documentation_; // Lazy creation
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 public:
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 RestApiCall(RestApiOutput& output,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 RestApi& context,
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
56 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
57 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
58 const char* username,
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
59 HttpMethod method,
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
60 const HttpToolbox::Arguments& httpHeaders,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
61 const HttpToolbox::Arguments& uriComponents,
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 const UriComponents& trailing,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 const UriComponents& fullUri) :
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 output_(output),
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 context_(context),
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
66 origin_(origin),
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
67 remoteIp_(remoteIp),
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
68 username_(username),
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 httpHeaders_(httpHeaders),
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 uriComponents_(uriComponents),
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 trailing_(trailing),
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
72 fullUri_(fullUri),
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
73 method_(method)
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 RestApiOutput& GetOutput()
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 return output_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 RestApi& GetContext()
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 return context_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 const UriComponents& GetFullUri() const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 return fullUri_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 const UriComponents& GetTrailingUri() const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 return trailing_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
4424
83371ccdfe80 openapi documentation is now completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4412
diff changeset
97 void GetUriComponentsNames(std::set<std::string>& components) const;
83371ccdfe80 openapi documentation is now completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4412
diff changeset
98
4406
4cb9f66a1c7c documenting generation of images
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4399
diff changeset
99 bool HasUriComponent(const std::string& name) const
4cb9f66a1c7c documenting generation of images
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4399
diff changeset
100 {
4cb9f66a1c7c documenting generation of images
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4399
diff changeset
101 return (uriComponents_.find(name) != uriComponents_.end());
4cb9f66a1c7c documenting generation of images
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4399
diff changeset
102 }
4cb9f66a1c7c documenting generation of images
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4399
diff changeset
103
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 std::string GetUriComponent(const std::string& name,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 const std::string& defaultValue) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 {
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
107 return HttpToolbox::GetArgument(uriComponents_, name, defaultValue);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 std::string GetHttpHeader(const std::string& name,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 const std::string& defaultValue) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 {
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
113 return HttpToolbox::GetArgument(httpHeaders_, name, defaultValue);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
116 const HttpToolbox::Arguments& GetHttpHeaders() const
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 return httpHeaders_;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
121 void ParseCookies(HttpToolbox::Arguments& result) const
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 {
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
123 HttpToolbox::ParseCookies(result, httpHeaders_);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
126 std::string FlattenUri() const;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
127
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
128 RequestOrigin GetRequestOrigin() const
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
129 {
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
130 return origin_;
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
131 }
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
132
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
133 const char* GetRemoteIp() const
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
134 {
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
135 return remoteIp_;
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
136 }
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
137
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
138 const char* GetUsername() const
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
139 {
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
140 return username_;
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
141 }
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
142
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 virtual bool ParseJsonRequest(Json::Value& result) const = 0;
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
144
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
145 RestApiCallDocumentation& GetDocumentation();
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
146
4412
68b96234fbd6 automated generation of the cheat sheet of the REST API, to be included in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4406
diff changeset
147 HttpMethod GetMethod() const
68b96234fbd6 automated generation of the cheat sheet of the REST API, to be included in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4406
diff changeset
148 {
68b96234fbd6 automated generation of the cheat sheet of the REST API, to be included in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4406
diff changeset
149 return method_;
68b96234fbd6 automated generation of the cheat sheet of the REST API, to be included in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4406
diff changeset
150 }
68b96234fbd6 automated generation of the cheat sheet of the REST API, to be included in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4406
diff changeset
151
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
152 bool IsDocumentation() const
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
153 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
154 return (origin_ == RequestOrigin_Documentation);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4392
diff changeset
155 }
4473
68f52897c119 new URIs: /tools/accepted-transfer-syntaxes and /tools/unknown-sop-class-accepted to replace Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
156
68f52897c119 new URIs: /tools/accepted-transfer-syntaxes and /tools/unknown-sop-class-accepted to replace Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
157 static bool ParseBoolean(const std::string& value);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 };
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 }