Mercurial > hg > orthanc
diff OrthancFramework/Sources/RestApi/RestApiCallDocumentation.h @ 4403:ad646ff506d0
cont openapi
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 23 Dec 2020 18:32:13 +0100 |
parents | 354ea95b294a |
children | f34634916d8c |
line wrap: on
line diff
--- a/OrthancFramework/Sources/RestApi/RestApiCallDocumentation.h Wed Dec 23 15:16:37 2020 +0100 +++ b/OrthancFramework/Sources/RestApi/RestApiCallDocumentation.h Wed Dec 23 18:32:13 2020 +0100 @@ -43,14 +43,48 @@ Type_Number, Type_Boolean, Type_JsonListOfStrings, + Type_JsonListOfObjects, Type_JsonObject }; private: - struct Parameter + class Parameter { + private: Type type_; std::string description_; + bool required_; + + public: + Parameter() : + type_(Type_Unknown), + required_(false) + { + } + + Parameter(Type type, + const std::string& description, + bool required) : + type_(type), + description_(description), + required_(required) + { + } + + Type GetType() const + { + return type_; + } + + const std::string& GetDescription() const + { + return description_; + } + + bool IsRequired() const + { + return required_; + } }; typedef std::map<std::string, Parameter> Parameters; @@ -103,7 +137,8 @@ RestApiCallDocumentation& SetRequestField(const std::string& name, Type type, - const std::string& description); + const std::string& description, + bool required); RestApiCallDocumentation& AddAnswerType(MimeType type, const std::string& description); @@ -122,7 +157,8 @@ RestApiCallDocumentation& SetHttpGetArgument(const std::string& name, Type type, - const std::string& description); + const std::string& description, + bool required); RestApiCallDocumentation& SetAnswerField(const std::string& name, Type type,