orthanc: OrthancFramework/Sources/RestApi/RestApi.cpp annotate

annotate OrthancFramework/Sources/RestApi/RestApi.cpp @ 5804:25df40a274fd find-refactoring

/changes: allowing filtering on multiple changes

author	Alain Mazy <am@orthanc.team>
date	Mon, 23 Sep 2024 15:40:27 +0200
parents	f7adfb22e20e
children

rev	line source
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1 /**
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2 * Orthanc - A Lightweight, RESTful DICOM Store
1900 b1291df2f780 2016 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: 1113 diff changeset	4 * Department, University Hospital of Liege, Belgium
5640 f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis Sebastien Jodogne <s.jodogne@gmail.com> parents: 5485 diff changeset	5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis Sebastien Jodogne <s.jodogne@gmail.com> parents: 5485 diff changeset	6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485 48b8dae6dc77 upgrade to year 2024 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5394 diff changeset	7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	8 *
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	9 * 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	10 * 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	11 * 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	12 * the License, or (at your option) any later version.
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	13 *
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	14 * This program is distributed in the hope that it will be useful, but
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	15 * WITHOUT ANY WARRANTY; without even the implied warranty of
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 * 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	17 * Lesser General Public License for more details.
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	18 *
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	19 * 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	20 * 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	21 * <http://www.gnu.org/licenses/>.
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	22 **/
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	23
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	24
824 a811bdf8b8eb precompiled headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 689 diff changeset	25 #include "../PrecompiledHeaders.h"
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	26 #include "RestApi.h"
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	27
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: 4330 diff changeset	28 #include "../HttpServer/StringHttpOutput.h"
1486 f967bdf8534e refactoring to Logging.h Sebastien Jodogne <s.jodogne@gmail.com> parents: 1446 diff changeset	29 #include "../Logging.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: 4330 diff changeset	30 #include "../OrthancException.h"
1486 f967bdf8534e refactoring to Logging.h Sebastien Jodogne <s.jodogne@gmail.com> parents: 1446 diff changeset	31
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: 4410 diff changeset	32 #include <boost/algorithm/string/replace.hpp>
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	33 #include <boost/math/special_functions/round.hpp>
249 5694365ecb96 fixes for windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 215 diff changeset	34 #include <stdlib.h> // To define "_exit()" under Windows
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	35 #include <stdio.h>
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	36
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	37 namespace Orthanc
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	38 {
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	39 namespace
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	40 {
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	41 // Anonymous namespace to avoid clashes between compilation modules
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	42 class HttpHandlerVisitor : public RestApiHierarchy::IVisitor
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	43 {
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	44 private:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	45 RestApi& api_;
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	46 RestApiOutput& output_;
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	47 RequestOrigin origin_;
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	48 const char* remoteIp_;
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	49 const char* username_;
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	50 HttpMethod method_;
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	51 const HttpToolbox::Arguments& headers_;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	52 const HttpToolbox::Arguments& getArguments_;
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	53 const void* bodyData_;
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	54 size_t bodySize_;
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	55
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	56 public:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	57 HttpHandlerVisitor(RestApi& api,
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	58 RestApiOutput& output,
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	59 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	60 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	61 const char* username,
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	62 HttpMethod method,
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	63 const HttpToolbox::Arguments& headers,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	64 const HttpToolbox::Arguments& getArguments,
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	65 const void* bodyData,
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	66 size_t bodySize) :
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	67 api_(api),
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	68 output_(output),
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	69 origin_(origin),
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	70 remoteIp_(remoteIp),
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	71 username_(username),
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	72 method_(method),
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	73 headers_(headers),
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	74 getArguments_(getArguments),
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	75 bodyData_(bodyData),
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	76 bodySize_(bodySize)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77 {
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78 }
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	79
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	80 virtual bool Visit(const RestApiHierarchy::Resource& resource,
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	81 const UriComponents& uri,
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: 4330 diff changeset	82 bool hasTrailing,
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	83 const HttpToolbox::Arguments& components,
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	84 const UriComponents& trailing)
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	85 {
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	86 if (resource.HasHandler(method_))
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	87 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	88 switch (method_)
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	89 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	90 case HttpMethod_Get:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	91 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	92 RestApiGetCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	93 headers_, components, trailing, uri, getArguments_);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	94 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	95 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	96 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	97
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	98 case HttpMethod_Post:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	99 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	100 RestApiPostCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	101 headers_, components, trailing, uri, bodyData_, bodySize_);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	102 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	103 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	104 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	105
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	106 case HttpMethod_Delete:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	107 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	108 RestApiDeleteCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	109 headers_, components, trailing, uri);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	110 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	111 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	112 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	113
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	114 case HttpMethod_Put:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	115 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	116 RestApiPutCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	117 headers_, components, trailing, uri, bodyData_, bodySize_);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	118 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	119 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	120 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	121
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	122 default:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	123 return false;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	124 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	125 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	126
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	127 return false;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	128 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	129 };
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: 4330 diff changeset	130
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: 4330 diff changeset	131
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: 4330 diff changeset	132
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: 4410 diff changeset	133 class DocumentationVisitor : public RestApiHierarchy::IVisitor
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: 4330 diff changeset	134 {
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: 4330 diff changeset	135 private:
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: 4330 diff changeset	136 RestApi& restApi_;
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	137 size_t successPathsCount_;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	138 size_t totalPathsCount_;
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: 4410 diff changeset	139
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: 4410 diff changeset	140 protected:
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: 4410 diff changeset	141 virtual bool HandleCall(RestApiCall& call,
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	142 const std::string& path,
4485 f19de27a2465 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	143 const std::set<std::string>& uriArgumentsNames) = 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: 4330 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: 4330 diff changeset	145 public:
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: 4410 diff changeset	146 explicit DocumentationVisitor(RestApi& restApi) :
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	147 restApi_(restApi),
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	148 successPathsCount_(0),
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	149 totalPathsCount_(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: 4330 diff changeset	150 {
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: 4330 diff changeset	151 }
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: 4330 diff changeset	152
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: 4330 diff changeset	153 virtual bool Visit(const RestApiHierarchy::Resource& resource,
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: 4330 diff changeset	154 const UriComponents& uri,
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: 4330 diff changeset	155 bool hasTrailing,
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: 4330 diff changeset	156 const HttpToolbox::Arguments& components,
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: 4330 diff changeset	157 const UriComponents& trailing)
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: 4330 diff changeset	158 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	159 std::string path = Toolbox::FlattenUri(uri);
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	160 if (hasTrailing)
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	161 {
5393 c5c00bee291a in openapi generator: renamed '...' into 'path' since '...' is an invalid name Alain Mazy <am@osimis.io> parents: 5185 diff changeset	162 path += "/{path}";
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	163 }
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: 4330 diff changeset	164
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	165 std::set<std::string> uriArgumentsNames;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	166 HttpToolbox::Arguments uriArguments;
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	167
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	168 for (HttpToolbox::Arguments::const_iterator
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	169 it = components.begin(); it != components.end(); ++it)
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	170 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	171 assert(it->second.empty());
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	172 uriArgumentsNames.insert(it->first.c_str());
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	173 uriArguments[it->first] = "";
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	174 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4400 diff changeset	175
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	176 if (hasTrailing)
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	177 {
5393 c5c00bee291a in openapi generator: renamed '...' into 'path' since '...' is an invalid name Alain Mazy <am@osimis.io> parents: 5185 diff changeset	178 uriArgumentsNames.insert("path");
c5c00bee291a in openapi generator: renamed '...' into 'path' since '...' is an invalid name Alain Mazy <am@osimis.io> parents: 5185 diff changeset	179 uriArguments["path"] = "";
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	180 }
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	181
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	182 if (resource.HasHandler(HttpMethod_Get))
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: 4330 diff changeset	183 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	184 totalPathsCount_ ++;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	185
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: 4330 diff changeset	186 StringHttpOutput o1;
5119 bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 4870 diff changeset	187 HttpOutput o2(o1, false /* assume no keep-alive */, 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: 4330 diff changeset	188 RestApiOutput o3(o2, HttpMethod_Get);
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: 4330 diff changeset	189 RestApiGetCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
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: 4330 diff changeset	190 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	191 uriArguments, UriComponents() /* 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: 4330 diff changeset	192 uri, HttpToolbox::Arguments() /* GET arguments */);
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: 4330 diff changeset	193
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: 4330 diff changeset	194 bool ok = false;
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: 4330 diff changeset	195
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: 4330 diff changeset	196 try
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: 4330 diff changeset	197 {
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: 4330 diff changeset	198 ok = (resource.Handle(call) &&
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	199 HandleCall(call, path, uriArgumentsNames));
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: 4330 diff changeset	200 }
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	201 catch (OrthancException& e)
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: 4330 diff changeset	202 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	203 LOG(ERROR) << "Exception while documenting GET " << path << ": " << e.What();
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: 4330 diff changeset	204 }
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: 4330 diff changeset	205 catch (boost::bad_lexical_cast&)
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: 4330 diff changeset	206 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	207 LOG(ERROR) << "Bad lexical cast while documenting GET " << path;
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: 4330 diff changeset	208 }
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: 4330 diff changeset	209
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: 4330 diff changeset	210 if (ok)
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: 4330 diff changeset	211 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	212 successPathsCount_ ++;
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: 4330 diff changeset	213 }
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: 4330 diff changeset	214 else
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: 4330 diff changeset	215 {
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: 4330 diff changeset	216 LOG(WARNING) << "Ignoring URI without API documentation: GET " << path;
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: 4330 diff changeset	217 }
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: 4330 diff changeset	218 }
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: 4330 diff changeset	219
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	220 if (resource.HasHandler(HttpMethod_Post))
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: 4330 diff changeset	221 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	222 totalPathsCount_ ++;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	223
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: 4330 diff changeset	224 StringHttpOutput o1;
5119 bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 4870 diff changeset	225 HttpOutput o2(o1, false /* assume no keep-alive */, 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: 4330 diff changeset	226 RestApiOutput o3(o2, HttpMethod_Post);
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: 4330 diff changeset	227 RestApiPostCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
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: 4330 diff changeset	228 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	229 uriArguments, UriComponents() /* trailing */,
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	230 uri, NULL /* body /, 0 / body size */);
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: 4330 diff changeset	231
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: 4330 diff changeset	232 bool ok = false;
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: 4330 diff changeset	233
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: 4330 diff changeset	234 try
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: 4330 diff changeset	235 {
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: 4330 diff changeset	236 ok = (resource.Handle(call) &&
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	237 HandleCall(call, path, uriArgumentsNames));
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: 4330 diff changeset	238 }
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	239 catch (OrthancException& e)
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: 4330 diff changeset	240 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	241 LOG(ERROR) << "Exception while documenting POST " << path << ": " << e.What();
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: 4330 diff changeset	242 }
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: 4330 diff changeset	243 catch (boost::bad_lexical_cast&)
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: 4330 diff changeset	244 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	245 LOG(ERROR) << "Bad lexical cast while documenting POST " << path;
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: 4330 diff changeset	246 }
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: 4330 diff changeset	247
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: 4330 diff changeset	248 if (ok)
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: 4330 diff changeset	249 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	250 successPathsCount_ ++;
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: 4330 diff changeset	251 }
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: 4330 diff changeset	252 else
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: 4330 diff changeset	253 {
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: 4330 diff changeset	254 LOG(WARNING) << "Ignoring URI without API documentation: POST " << path;
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: 4330 diff changeset	255 }
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: 4330 diff changeset	256 }
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: 4330 diff changeset	257
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	258 if (resource.HasHandler(HttpMethod_Delete))
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: 4330 diff changeset	259 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	260 totalPathsCount_ ++;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	261
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: 4330 diff changeset	262 StringHttpOutput o1;
5119 bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 4870 diff changeset	263 HttpOutput o2(o1, false /* assume no keep-alive */, 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: 4330 diff changeset	264 RestApiOutput o3(o2, HttpMethod_Delete);
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: 4330 diff changeset	265 RestApiDeleteCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
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: 4330 diff changeset	266 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	267 uriArguments, UriComponents() /* trailing */, uri);
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: 4330 diff changeset	268
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: 4330 diff changeset	269 bool ok = false;
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: 4330 diff changeset	270
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: 4330 diff changeset	271 try
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: 4330 diff changeset	272 {
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: 4330 diff changeset	273 ok = (resource.Handle(call) &&
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	274 HandleCall(call, path, uriArgumentsNames));
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: 4330 diff changeset	275 }
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	276 catch (OrthancException& e)
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: 4330 diff changeset	277 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	278 LOG(ERROR) << "Exception while documenting DELETE " << path << ": " << e.What();
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: 4330 diff changeset	279 }
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: 4330 diff changeset	280 catch (boost::bad_lexical_cast&)
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: 4330 diff changeset	281 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	282 LOG(ERROR) << "Bad lexical cast while documenting DELETE " << path;
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: 4330 diff changeset	283 }
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: 4330 diff changeset	284
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: 4330 diff changeset	285 if (ok)
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: 4330 diff changeset	286 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	287 successPathsCount_ ++;
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: 4330 diff changeset	288 }
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: 4330 diff changeset	289 else
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: 4330 diff changeset	290 {
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: 4330 diff changeset	291 LOG(WARNING) << "Ignoring URI without API documentation: DELETE " << path;
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: 4330 diff changeset	292 }
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: 4330 diff changeset	293 }
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: 4330 diff changeset	294
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	295 if (resource.HasHandler(HttpMethod_Put))
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: 4330 diff changeset	296 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	297 totalPathsCount_ ++;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	298
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: 4330 diff changeset	299 StringHttpOutput o1;
5119 bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 4870 diff changeset	300 HttpOutput o2(o1, false /* assume no keep-alive */, 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: 4330 diff changeset	301 RestApiOutput o3(o2, HttpMethod_Put);
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: 4330 diff changeset	302 RestApiPutCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
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: 4330 diff changeset	303 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	304 uriArguments, UriComponents() /* trailing */, uri,
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	305 NULL /* body /, 0 / body size */);
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: 4330 diff changeset	306
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: 4330 diff changeset	307 bool ok = false;
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: 4330 diff changeset	308
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: 4330 diff changeset	309 try
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: 4330 diff changeset	310 {
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: 4330 diff changeset	311 ok = (resource.Handle(call) &&
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	312 HandleCall(call, path, uriArgumentsNames));
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: 4330 diff changeset	313 }
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	314 catch (OrthancException& e)
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: 4330 diff changeset	315 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	316 LOG(ERROR) << "Exception while documenting PUT " << path << ": " << e.What();
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: 4330 diff changeset	317 }
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: 4330 diff changeset	318 catch (boost::bad_lexical_cast&)
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: 4330 diff changeset	319 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	320 LOG(ERROR) << "Bad lexical cast while documenting PUT " << path;
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: 4330 diff changeset	321 }
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: 4330 diff changeset	322
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: 4330 diff changeset	323 if (ok)
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: 4330 diff changeset	324 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	325 successPathsCount_ ++;
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: 4330 diff changeset	326 }
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: 4330 diff changeset	327 else
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: 4330 diff changeset	328 {
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: 4330 diff changeset	329 LOG(WARNING) << "Ignoring URI without API documentation: PUT " << path;
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: 4330 diff changeset	330 }
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: 4330 diff changeset	331 }
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: 4330 diff changeset	332
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: 4330 diff changeset	333 return true;
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: 4330 diff changeset	334 }
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: 4330 diff changeset	335
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	336 size_t GetSuccessPathsCount() const
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	337 {
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	338 return successPathsCount_;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	339 }
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	340
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	341 size_t GetTotalPathsCount() const
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	342 {
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	343 return totalPathsCount_;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	344 }
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: 4410 diff changeset	345
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: 4410 diff changeset	346 void LogStatistics() 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: 4410 diff changeset	347 {
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: 4410 diff changeset	348 assert(GetSuccessPathsCount() <= GetTotalPathsCount());
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: 4410 diff changeset	349 size_t total = GetTotalPathsCount();
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: 4410 diff changeset	350 if (total == 0)
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: 4410 diff changeset	351 {
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: 4410 diff changeset	352 total = 1; // Avoid division by zero
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: 4410 diff changeset	353 }
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: 4410 diff changeset	354 float coverage = (100.0f * static_cast<float>(GetSuccessPathsCount()) /
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: 4410 diff changeset	355 static_cast<float>(total));
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: 4410 diff changeset	356
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: 4410 diff changeset	357 LOG(WARNING) << "The documentation of the REST API contains " << GetSuccessPathsCount()
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: 4410 diff changeset	358 << " paths over a total of " << GetTotalPathsCount() << " paths "
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: 4410 diff changeset	359 << "(coverage: " << static_cast<unsigned int>(boost::math::iround(coverage)) << "%)";
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: 4410 diff changeset	360 }
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: 4410 diff changeset	361 };
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: 4410 diff changeset	362
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: 4410 diff changeset	363
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: 4410 diff changeset	364 class OpenApiVisitor : public DocumentationVisitor
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: 4410 diff changeset	365 {
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: 4410 diff changeset	366 private:
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: 4410 diff changeset	367 Json::Value paths_;
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: 4410 diff changeset	368
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: 4410 diff changeset	369 protected:
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: 4410 diff changeset	370 virtual bool HandleCall(RestApiCall& call,
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	371 const std::string& path,
4485 f19de27a2465 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	372 const std::set<std::string>& uriArgumentsNames) ORTHANC_OVERRIDE
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: 4410 diff changeset	373 {
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: 4410 diff changeset	374 Json::Value v;
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	375 if (call.GetDocumentation().FormatOpenApi(v, uriArgumentsNames, path))
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: 4410 diff changeset	376 {
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: 4410 diff changeset	377 std::string 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: 4410 diff changeset	378
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: 4410 diff changeset	379 switch (call.GetMethod())
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: 4410 diff changeset	380 {
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: 4410 diff changeset	381 case HttpMethod_Get:
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: 4410 diff changeset	382 method = "get";
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: 4410 diff changeset	383 break;
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: 4410 diff changeset	384
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: 4410 diff changeset	385 case HttpMethod_Post:
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: 4410 diff changeset	386 method = "post";
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: 4410 diff changeset	387 break;
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: 4410 diff changeset	388
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: 4410 diff changeset	389 case HttpMethod_Delete:
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: 4410 diff changeset	390 method = "delete";
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: 4410 diff changeset	391 break;
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: 4410 diff changeset	392
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: 4410 diff changeset	393 case HttpMethod_Put:
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: 4410 diff changeset	394 method = "put";
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: 4410 diff changeset	395 break;
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: 4410 diff changeset	396
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: 4410 diff changeset	397 default:
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: 4410 diff changeset	398 throw OrthancException(ErrorCode_ParameterOutOfRange);
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: 4410 diff changeset	399 }
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: 4410 diff changeset	400
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: 4410 diff changeset	401 if ((paths_.isMember(path) &&
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: 4410 diff changeset	402 paths_[path].type() != Json::objectValue) \|\|
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: 4410 diff changeset	403 paths_[path].isMember(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: 4410 diff changeset	404 {
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: 4410 diff changeset	405 throw OrthancException(ErrorCode_InternalError);
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: 4410 diff changeset	406 }
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: 4410 diff changeset	407
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: 4410 diff changeset	408 paths_[path][method] = v;
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: 4410 diff changeset	409
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: 4410 diff changeset	410 return true;
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: 4410 diff changeset	411 }
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: 4410 diff changeset	412 else
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: 4410 diff changeset	413 {
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: 4410 diff changeset	414 return false;
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: 4410 diff changeset	415 }
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: 4410 diff changeset	416 }
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: 4410 diff changeset	417
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: 4410 diff changeset	418 public:
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: 4410 diff changeset	419 explicit OpenApiVisitor(RestApi& restApi) :
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: 4410 diff changeset	420 DocumentationVisitor(restApi),
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: 4410 diff changeset	421 paths_(Json::objectValue)
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: 4410 diff changeset	422 {
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: 4410 diff changeset	423 }
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: 4410 diff changeset	424
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: 4410 diff changeset	425 const Json::Value& GetPaths() 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: 4410 diff changeset	426 {
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: 4410 diff changeset	427 return paths_;
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: 4410 diff changeset	428 }
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: 4410 diff changeset	429 };
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: 4410 diff changeset	430
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: 4410 diff changeset	431
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: 4410 diff changeset	432 class ReStructuredTextCheatSheet : public DocumentationVisitor
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: 4410 diff changeset	433 {
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: 4410 diff changeset	434 private:
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: 4410 diff changeset	435 class Path
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: 4410 diff changeset	436 {
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: 4410 diff changeset	437 private:
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: 4410 diff changeset	438 bool hasGet_;
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: 4410 diff changeset	439 bool hasPost_;
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: 4410 diff changeset	440 bool hasDelete_;
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: 4410 diff changeset	441 bool hasPut_;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	442 std::string getTag_;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	443 std::string postTag_;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	444 std::string deleteTag_;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	445 std::string putTag_;
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: 4410 diff changeset	446 std::string summary_;
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	447 bool getDeprecated_;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	448 bool postDeprecated_;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	449 bool deleteDeprecated_;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	450 bool putDeprecated_;
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: 4410 diff changeset	451 HttpMethod summaryOrigin_;
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: 4410 diff changeset	452
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: 4410 diff changeset	453 public:
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: 4410 diff changeset	454 Path() :
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: 4410 diff changeset	455 hasGet_(false),
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: 4410 diff changeset	456 hasPost_(false),
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: 4410 diff changeset	457 hasDelete_(false),
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: 4410 diff changeset	458 hasPut_(false),
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	459 getDeprecated_(false),
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	460 postDeprecated_(false),
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	461 deleteDeprecated_(false),
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	462 putDeprecated_(false),
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: 4410 diff changeset	463 summaryOrigin_(HttpMethod_Get) // Dummy initialization
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: 4410 diff changeset	464 {
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: 4410 diff changeset	465 }
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: 4410 diff changeset	466
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	467 void AddMethod(HttpMethod method,
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	468 const std::string& tag,
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	469 bool deprecated)
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: 4410 diff changeset	470 {
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: 4410 diff changeset	471 switch (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: 4410 diff changeset	472 {
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: 4410 diff changeset	473 case HttpMethod_Get:
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	474 if (hasGet_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	475 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	476 throw OrthancException(ErrorCode_InternalError);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	477 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	478
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: 4410 diff changeset	479 hasGet_ = true;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	480 getTag_ = tag;
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	481 getDeprecated_ = deprecated;
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: 4410 diff changeset	482 break;
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: 4410 diff changeset	483
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: 4410 diff changeset	484 case HttpMethod_Post:
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	485 if (hasPost_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	486 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	487 throw OrthancException(ErrorCode_InternalError);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	488 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	489
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: 4410 diff changeset	490 hasPost_ = true;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	491 postTag_ = tag;
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	492 postDeprecated_ = deprecated;
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: 4410 diff changeset	493 break;
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: 4410 diff changeset	494
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: 4410 diff changeset	495 case HttpMethod_Delete:
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	496 if (hasDelete_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	497 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	498 throw OrthancException(ErrorCode_InternalError);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	499 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	500
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: 4410 diff changeset	501 hasDelete_ = true;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	502 deleteTag_ = tag;
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	503 deleteDeprecated_ = deprecated;
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: 4410 diff changeset	504 break;
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: 4410 diff changeset	505
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: 4410 diff changeset	506 case HttpMethod_Put:
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	507 if (hasPut_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	508 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	509 throw OrthancException(ErrorCode_InternalError);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	510 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	511
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: 4410 diff changeset	512 hasPut_ = true;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	513 putTag_ = tag;
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	514 putDeprecated_ = deprecated;
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: 4410 diff changeset	515 break;
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: 4410 diff changeset	516
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: 4410 diff changeset	517 default:
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: 4410 diff changeset	518 throw OrthancException(ErrorCode_ParameterOutOfRange);
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: 4410 diff changeset	519 }
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: 4410 diff changeset	520 }
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: 4410 diff changeset	521
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	522 void SetSummary(const std::string& summary,
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: 4410 diff changeset	523 HttpMethod newOrigin)
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: 4410 diff changeset	524 {
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: 4410 diff changeset	525 if (!summary.empty())
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: 4410 diff changeset	526 {
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: 4410 diff changeset	527 bool replace;
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: 4410 diff changeset	528
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: 4410 diff changeset	529 if (summary_.empty())
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: 4410 diff changeset	530 {
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: 4410 diff changeset	531 // We don't have a summary so far
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: 4410 diff changeset	532 replace = true;
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: 4410 diff changeset	533 }
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: 4410 diff changeset	534 else
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: 4410 diff changeset	535 {
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: 4410 diff changeset	536 // We already have a summary. Replace it if the new
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: 4410 diff changeset	537 // summary is associated with a HTTP method of higher
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: 4410 diff changeset	538 // weight (GET > POST > DELETE > PUT)
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: 4410 diff changeset	539 switch (summaryOrigin_)
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: 4410 diff changeset	540 {
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: 4410 diff changeset	541 case HttpMethod_Get:
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: 4410 diff changeset	542 replace = false;
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: 4410 diff changeset	543 break;
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: 4410 diff changeset	544
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: 4410 diff changeset	545 case HttpMethod_Post:
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: 4410 diff changeset	546 replace = (newOrigin == HttpMethod_Get);
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: 4410 diff changeset	547 break;
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: 4410 diff changeset	548
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: 4410 diff changeset	549 case HttpMethod_Delete:
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: 4410 diff changeset	550 replace = (newOrigin == HttpMethod_Get \|\|
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: 4410 diff changeset	551 newOrigin == HttpMethod_Post);
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: 4410 diff changeset	552 break;
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: 4410 diff changeset	553
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: 4410 diff changeset	554 case HttpMethod_Put:
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: 4410 diff changeset	555 replace = (newOrigin == HttpMethod_Get \|\|
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: 4410 diff changeset	556 newOrigin == HttpMethod_Post \|\|
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: 4410 diff changeset	557 newOrigin == HttpMethod_Delete);
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: 4410 diff changeset	558 break;
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: 4410 diff changeset	559
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: 4410 diff changeset	560 default:
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: 4410 diff changeset	561 throw OrthancException(ErrorCode_ParameterOutOfRange);
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: 4410 diff changeset	562 }
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: 4410 diff changeset	563 }
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: 4410 diff changeset	564
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: 4410 diff changeset	565 if (replace)
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: 4410 diff changeset	566 {
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: 4410 diff changeset	567 summary_ = summary;
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: 4410 diff changeset	568 summaryOrigin_ = newOrigin;
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: 4410 diff changeset	569 }
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: 4410 diff changeset	570 }
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: 4410 diff changeset	571 }
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: 4410 diff changeset	572
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: 4410 diff changeset	573 const std::string& GetSummary() 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: 4410 diff changeset	574 {
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: 4410 diff changeset	575 return summary_;
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: 4410 diff changeset	576 }
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	577
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	578 static std::string FormatTag(const std::string& tag)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	579 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	580 if (tag.empty())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	581 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	582 return tag;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	583 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	584 else
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	585 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	586 std::string s;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	587 s.reserve(tag.size());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	588 s.push_back(tag[0]);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	589
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	590 for (size_t i = 1; i < tag.size(); i++)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	591 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	592 if (tag[i] == ' ')
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	593 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	594 s.push_back('-');
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	595 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	596 else if (isupper(tag[i]) &&
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	597 tag[i - 1] == ' ')
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	598 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	599 s.push_back(tolower(tag[i]));
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	600 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	601 else
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	602 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	603 s.push_back(tag[i]);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	604 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	605 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	606
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	607 return s;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	608 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	609 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	610
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	611 std::string Format(const std::string& openApiUrl,
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	612 HttpMethod method,
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	613 const std::string& uri) const
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	614 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	615 std::string p = uri;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	616 boost::replace_all(p, "/", "~1");
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	617
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	618 std::string verb;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	619 std::string url;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	620
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	621 switch (method)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	622 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	623 case HttpMethod_Get:
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	624 if (hasGet_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	625 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	626 verb = (getDeprecated_ ? "(get)" : "GET");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	627 url = openApiUrl + "#tag/" + FormatTag(getTag_) + "/paths/" + p + "/get";
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	628 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	629 break;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	630
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	631 case HttpMethod_Post:
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	632 if (hasPost_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	633 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	634 verb = (postDeprecated_ ? "(post)" : "POST");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	635 url = openApiUrl + "#tag/" + FormatTag(postTag_) + "/paths/" + p + "/post";
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	636 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	637 break;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	638
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	639 case HttpMethod_Delete:
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	640 if (hasDelete_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	641 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	642 verb = (deleteDeprecated_ ? "(delete)" : "DELETE");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	643 url = openApiUrl + "#tag/" + FormatTag(deleteTag_) + "/paths/" + p + "/delete";
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	644 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	645 break;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	646
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	647 case HttpMethod_Put:
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	648 if (hasPut_)
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	649 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	650 verb = (putDeprecated_ ? "(put)" : "PUT");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	651 url = openApiUrl + "#tag/" + FormatTag(putTag_) + "/paths/" + p + "/put";
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	652 }
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	653 break;
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	654
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	655 default:
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	656 throw OrthancException(ErrorCode_InternalError);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	657 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	658
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	659 if (verb.empty())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	660 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	661 return "";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	662 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	663 else if (openApiUrl.empty())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	664 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	665 return verb;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	666 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	667 else
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	668 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	669 return "`" + verb + " <" + url + ">`__";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	670 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	671 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	672
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	673 bool HasDeprecated() const
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	674 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	675 return ((hasGet_ && getDeprecated_) \|\|
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	676 (hasPost_ && postDeprecated_) \|\|
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	677 (hasDelete_ && deleteDeprecated_) \|\|
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	678 (hasPut_ && putDeprecated_));
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	679 }
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: 4410 diff changeset	680 };
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: 4410 diff changeset	681
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: 4410 diff changeset	682 typedef std::map<std::string, Path> Paths;
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: 4410 diff changeset	683
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: 4410 diff changeset	684 Paths paths_;
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: 4410 diff changeset	685
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: 4410 diff changeset	686 protected:
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: 4410 diff changeset	687 virtual bool HandleCall(RestApiCall& call,
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	688 const std::string& _path,
4485 f19de27a2465 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	689 const std::set<std::string>& uriArgumentsNames) ORTHANC_OVERRIDE
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: 4410 diff changeset	690 {
5394 002ba12a8bee fix openapi & cheatsheet visitors to include trailing 'path' in /instances/{id}/content/{path} url Alain Mazy <am@osimis.io> parents: 5393 diff changeset	691 Path& path = paths_[ _path ];
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: 4410 diff changeset	692
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	693 path.AddMethod(call.GetMethod(), call.GetDocumentation().GetTag(), call.GetDocumentation().IsDeprecated());
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: 4410 diff changeset	694
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: 4410 diff changeset	695 if (call.GetDocumentation().HasSummary())
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: 4410 diff changeset	696 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	697 path.SetSummary(call.GetDocumentation().GetSummary(), call.GetMethod());
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: 4410 diff changeset	698 }
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: 4410 diff changeset	699
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: 4410 diff changeset	700 return true;
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: 4410 diff changeset	701 }
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: 4410 diff changeset	702
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: 4410 diff changeset	703 public:
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: 4410 diff changeset	704 explicit ReStructuredTextCheatSheet(RestApi& restApi) :
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: 4410 diff changeset	705 DocumentationVisitor(restApi)
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: 4410 diff changeset	706 {
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: 4410 diff changeset	707 }
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: 4410 diff changeset	708
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: 4410 diff changeset	709 void Format(std::string& target,
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: 4410 diff changeset	710 const std::string& openApiUrl) 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: 4410 diff changeset	711 {
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: 4410 diff changeset	712 target += "Path,GET,POST,DELETE,PUT,Summary\n";
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: 4410 diff changeset	713 for (Paths::const_iterator it = paths_.begin(); it != paths_.end(); ++it)
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: 4410 diff changeset	714 {
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: 4410 diff changeset	715 target += "``" + it->first + "``,";
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	716 target += it->second.Format(openApiUrl, HttpMethod_Get, it->first) + ",";
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	717 target += it->second.Format(openApiUrl, HttpMethod_Post, it->first) + ",";
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	718 target += it->second.Format(openApiUrl, HttpMethod_Delete, it->first) + ",";
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4412 diff changeset	719 target += it->second.Format(openApiUrl, HttpMethod_Put, it->first) + ",";
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	720
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	721 if (it->second.HasDeprecated())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	722 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	723 target += "(deprecated) ";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	724 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	725
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: 4410 diff changeset	726 target += it->second.GetSummary() + "\n";
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: 4410 diff changeset	727 }
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: 4410 diff changeset	728 }
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: 4330 diff changeset	729 };
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	730 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	731
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	732
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	733
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	734 static void AddMethod(std::string& target,
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	735 const std::string& method)
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	736 {
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	737 if (target.size() > 0)
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	738 target += "," + method;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	739 else
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	740 target = method;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	741 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	742
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	743 static std::string MethodsToString(const std::set<HttpMethod>& methods)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	744 {
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	745 std::string s;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	746
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	747 if (methods.find(HttpMethod_Get) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	748 {
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	749 AddMethod(s, "GET");
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	750 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	751
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	752 if (methods.find(HttpMethod_Post) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	753 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	754 AddMethod(s, "POST");
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	755 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	756
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	757 if (methods.find(HttpMethod_Put) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	758 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	759 AddMethod(s, "PUT");
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	760 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	761
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	762 if (methods.find(HttpMethod_Delete) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	763 {
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	764 AddMethod(s, "DELETE");
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	765 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	766
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	767 return s;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	768 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	769
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	770
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	771
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: 4330 diff changeset	772 bool RestApi::CreateChunkedRequestReader(std::unique_ptr<IChunkedRequestReader>& target,
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: 4330 diff changeset	773 RequestOrigin origin,
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: 4330 diff changeset	774 const char* remoteIp,
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: 4330 diff changeset	775 const char* username,
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: 4330 diff changeset	776 HttpMethod method,
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: 4330 diff changeset	777 const UriComponents& uri,
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: 4330 diff changeset	778 const HttpToolbox::Arguments& headers)
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: 4330 diff changeset	779 {
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: 4330 diff changeset	780 return false;
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: 4330 diff changeset	781 }
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: 4330 diff changeset	782
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: 4330 diff changeset	783
895 7e8cde5905fd allow superposition of REST handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	784 bool RestApi::Handle(HttpOutput& output,
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	785 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	786 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	787 const char* username,
473 c9a5d72f8481 changing the namespace of HTTP enumerations Sebastien Jodogne <s.jodogne@gmail.com> parents: 416 diff changeset	788 HttpMethod method,
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	789 const UriComponents& uri,
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	790 const HttpToolbox::Arguments& headers,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	791 const HttpToolbox::GetArguments& getArguments,
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	792 const void* bodyData,
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	793 size_t bodySize)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	794 {
1368 b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1363 diff changeset	795 RestApiOutput wrappedOutput(output, method);
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	796
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	797 #if ORTHANC_ENABLE_PUGIXML == 1
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	798 {
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	799 // Look if the client wishes XML answers instead of JSON
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	800 // http://www.w3.org/Protocols/HTTP/HTRQ_Headers.html#z3
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	801 HttpToolbox::Arguments::const_iterator it = headers.find("accept");
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	802 if (it != headers.end())
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	803 {
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	804 std::vector<std::string> accepted;
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	805 Toolbox::TokenizeString(accepted, it->second, ';');
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	806 for (size_t i = 0; i < accepted.size(); i++)
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	807 {
2905 ae20fccdd867 refactoring mime types Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	808 if (accepted[i] == MIME_XML)
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	809 {
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	810 wrappedOutput.SetConvertJsonToXml(true);
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	811 }
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	812
2905 ae20fccdd867 refactoring mime types Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	813 if (accepted[i] == MIME_JSON)
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	814 {
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	815 wrappedOutput.SetConvertJsonToXml(false);
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	816 }
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	817 }
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	818 }
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	819 }
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	820 #endif
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	821
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	822 HttpToolbox::Arguments compiled;
1441 f3672356c121 refactoring: IHttpHandler and HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 1368 diff changeset	823 HttpToolbox::CompileGetArguments(compiled, getArguments);
1363 feaf2840917c Plugins now receive duplicated GET arguments in their REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	824
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	825 HttpHandlerVisitor visitor(*this, wrappedOutput, origin, remoteIp, username,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	826 method, headers, compiled, bodyData, bodySize);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	827
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	828 if (root_.LookupResource(uri, visitor))
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 895 diff changeset	829 {
1113 ba5c0908600c Refactoring of HttpOutput ("Content-Length" header is now always sent) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1063 diff changeset	830 wrappedOutput.Finalize();
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	831 return true;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 895 diff changeset	832 }
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 895 diff changeset	833
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	834 std::set<HttpMethod> methods;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	835 root_.GetAcceptedMethods(methods, uri);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	836
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	837 if (methods.empty())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	838 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	839 return false; // This URI is not served by this REST API
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	840 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	841 else
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	842 {
477 6f8ae46ed90e moves Sebastien Jodogne <s.jodogne@gmail.com> parents: 473 diff changeset	843 LOG(INFO) << "REST method " << EnumerationToString(method)
416 1188cb0ddaa5 http method faking Sebastien Jodogne <s.jodogne@gmail.com> parents: 398 diff changeset	844 << " not allowed on: " << Toolbox::FlattenUri(uri);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	845
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 980 diff changeset	846 output.SendMethodNotAllowed(MethodsToString(methods));
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	847
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	848 return true;
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	849 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	850 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	851
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	852 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	853 RestApiGetCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	854 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	855 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	856 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	857
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	858 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	859 RestApiPutCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	860 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	861 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	862 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	863
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	864 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	865 RestApiPostCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	866 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	867 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	868 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	869
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	870 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	871 RestApiDeleteCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	872 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	873 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	874 }
1063 0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	875
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	876 void RestApi::AutoListChildren(RestApiGetCall& call)
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: 4330 diff changeset	877 {
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: 4330 diff changeset	878 call.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: 4330 diff changeset	879 .SetTag("Other")
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	880 .SetSummary("List operations")
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	881 .SetDescription("List the available operations under URI `" + call.FlattenUri() + "`")
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: 4330 diff changeset	882 .AddAnswerType(MimeType_Json, "List of the available operations");
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: 4330 diff changeset	883
1063 0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	884 RestApi& context = call.GetContext();
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	885
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	886 Json::Value directory;
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	887 if (context.root_.GetDirectory(directory, call.GetFullUri()))
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	888 {
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: 4330 diff changeset	889 if (call.IsDocumentation())
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: 4330 diff changeset	890 {
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: 4330 diff changeset	891 call.GetDocumentation().SetSample(directory);
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	892
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	893 std::set<std::string> c;
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	894 call.GetUriComponentsNames(c);
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	895 for (std::set<std::string>::const_iterator it = c.begin(); it != c.end(); ++it)
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	896 {
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	897 call.GetDocumentation().SetUriArgument(*it, RestApiCallDocumentation::Type_String, "");
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	898 }
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: 4330 diff changeset	899 }
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: 4330 diff changeset	900 else
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: 4330 diff changeset	901 {
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: 4330 diff changeset	902 call.GetOutput().AnswerJson(directory);
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: 4330 diff changeset	903 }
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	904 }
1063 0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	905 }
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: 4330 diff changeset	906
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: 4330 diff changeset	907
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: 4330 diff changeset	908 void RestApi::GenerateOpenApiDocumentation(Json::Value& target)
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: 4330 diff changeset	909 {
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: 4330 diff changeset	910 OpenApiVisitor visitor(*this);
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: 4330 diff changeset	911
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: 4330 diff changeset	912 UriComponents root;
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	913 std::set<std::string> uriArgumentsNames;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	914 root_.ExploreAllResources(visitor, root, uriArgumentsNames);
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: 4330 diff changeset	915
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: 4330 diff changeset	916 target = Json::objectValue;
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: 4330 diff changeset	917
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	918 target["info"] = Json::objectValue;
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: 4330 diff changeset	919 target["openapi"] = "3.0.0";
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	920 target["servers"] = Json::arrayValue;
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: 4330 diff changeset	921 target["paths"] = visitor.GetPaths();
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	922
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: 4410 diff changeset	923 visitor.LogStatistics();
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: 4410 diff changeset	924 }
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: 4410 diff changeset	925
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: 4410 diff changeset	926
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: 4410 diff changeset	927 void RestApi::GenerateReStructuredTextCheatSheet(std::string& target,
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: 4410 diff changeset	928 const std::string& openApiUrl)
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: 4410 diff changeset	929 {
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: 4410 diff changeset	930 ReStructuredTextCheatSheet visitor(*this);
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	931
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: 4410 diff changeset	932 UriComponents root;
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: 4410 diff changeset	933 std::set<std::string> uriArgumentsNames;
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: 4410 diff changeset	934 root_.ExploreAllResources(visitor, root, uriArgumentsNames);
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: 4410 diff changeset	935
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: 4410 diff changeset	936 visitor.Format(target, openApiUrl);
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: 4410 diff changeset	937
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: 4410 diff changeset	938 visitor.LogStatistics();
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: 4330 diff changeset	939 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	940 }

Mercurial > hg > orthanc

annotate OrthancFramework/Sources/RestApi/RestApi.cpp @ 5804:25df40a274fd find-refactoring