feat: helpers for serverside validations

This adds validation method templates that can be used by `openapi-generator` to generate better serverside validation code.

All client and server code have been updated using a branch of `openapi-generator` that does that. A PR with that to `openapi-generator` repo will follow. A few test methods had to be changed to conform to the additional validations.

Author: tanmaykm

Project.toml

@@ -4,7 +4,7 @@ keywords = ["Swagger", "OpenAPI", "REST"]
 license = "MIT"
 desc = "OpenAPI server and client helper for Julia"
 authors = ["JuliaHub Inc."]
-version = "0.1.28"
+version = "0.2.0"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

src/val.jl

@@ -84,3 +84,5 @@ function validate_param(parameter, operation_or_model, rule, value, args...)
 end
 
 validate_property(::Type{T}, name::Symbol, val) where {T<:APIModel} = nothing
+validate_properties(::T) where {T<:APIModel} = nothing
+check_required(::T) where {T<:APIModel} = true

test/client/allany/AllAnyClient/.openapi-generator/VERSION

@@ -1 +1 @@
-7.0.1-SNAPSHOT
+7.13.0-SNAPSHOT

test/client/allany/AllAnyClient/README.md

@@ -6,6 +6,7 @@ API to test code generation for oneof anyof allof
 This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
 
 - API version: 0.0.1
+- Generator version: 7.13.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.JuliaClientCodegen
 
 

test/client/allany/AllAnyClient/docs/DefaultApi.md

@@ -24,7 +24,7 @@ Method | HTTP request | Description
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**any_of_base_type** | [**AnyOfBaseType**](AnyOfBaseType.md)|  | 
+**any_of_base_type** | [**AnyOfBaseType**](AnyOfBaseType.md) |  |
 
 ### Return type
 
@@ -52,7 +52,7 @@ No authorization required
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**any_of_mapped_pets** | [**AnyOfMappedPets**](AnyOfMappedPets.md)|  | 
+**any_of_mapped_pets** | [**AnyOfMappedPets**](AnyOfMappedPets.md) |  |
 
 ### Return type
 
@@ -80,7 +80,7 @@ No authorization required
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**any_of_pets** | [**AnyOfPets**](AnyOfPets.md)|  | 
+**any_of_pets** | [**AnyOfPets**](AnyOfPets.md) |  |
 
 ### Return type
 
@@ -108,7 +108,7 @@ No authorization required
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**type_with_all_array_types** | [**TypeWithAllArrayTypes**](TypeWithAllArrayTypes.md)|  | 
+**type_with_all_array_types** | [**TypeWithAllArrayTypes**](TypeWithAllArrayTypes.md) |  |
 
 ### Return type
 
@@ -136,7 +136,7 @@ No authorization required
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**one_of_base_type** | [**OneOfBaseType**](OneOfBaseType.md)|  | 
+**one_of_base_type** | [**OneOfBaseType**](OneOfBaseType.md) |  |
 
 ### Return type
 
@@ -164,7 +164,7 @@ No authorization required
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**one_of_mapped_pets** | [**OneOfMappedPets**](OneOfMappedPets.md)|  | 
+**one_of_mapped_pets** | [**OneOfMappedPets**](OneOfMappedPets.md) |  |
 
 ### Return type
 
@@ -192,7 +192,7 @@ No authorization required
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **_api** | **DefaultApi** | API context | 
-**one_of_pets** | [**OneOfPets**](OneOfPets.md)|  | 
+**one_of_pets** | [**OneOfPets**](OneOfPets.md) |  |
 
 ### Return type
 

test/client/allany/AllAnyClient/src/models/model_Cat.jl

@@ -20,20 +20,28 @@ Base.@kwdef mutable struct Cat <: OpenAPI.APIModel
     age::Union{Nothing, Int64} = nothing
 
     function Cat(pet_type, hunts, age, )
-        OpenAPI.validate_property(Cat, Symbol("pet_type"), pet_type)
-        OpenAPI.validate_property(Cat, Symbol("hunts"), hunts)
-        OpenAPI.validate_property(Cat, Symbol("age"), age)
-        return new(pet_type, hunts, age, )
+        o = new(pet_type, hunts, age, )
+        OpenAPI.validate_properties(o)
+        return o
     end
 end # type Cat
 
 const _property_types_Cat = Dict{Symbol,String}(Symbol("pet_type")=>"String", Symbol("hunts")=>"Bool", Symbol("age")=>"Int64", )
 OpenAPI.property_type(::Type{ Cat }, name::Symbol) = Union{Nothing,eval(Base.Meta.parse(_property_types_Cat[name]))}
 
-function check_required(o::Cat)
+function OpenAPI.check_required(o::Cat)
     o.pet_type === nothing && (return false)
     true
 end
 
+function OpenAPI.validate_properties(o::Cat)
+    OpenAPI.validate_property(Cat, Symbol("pet_type"), o.pet_type)
+    OpenAPI.validate_property(Cat, Symbol("hunts"), o.hunts)
+    OpenAPI.validate_property(Cat, Symbol("age"), o.age)
+end
+
 function OpenAPI.validate_property(::Type{ Cat }, name::Symbol, val)
+
+
+
 end

test/client/allany/AllAnyClient/src/models/model_Dog.jl

@@ -20,23 +20,32 @@ Base.@kwdef mutable struct Dog <: OpenAPI.APIModel
     breed::Union{Nothing, String} = nothing
 
     function Dog(pet_type, bark, breed, )
-        OpenAPI.validate_property(Dog, Symbol("pet_type"), pet_type)
-        OpenAPI.validate_property(Dog, Symbol("bark"), bark)
-        OpenAPI.validate_property(Dog, Symbol("breed"), breed)
-        return new(pet_type, bark, breed, )
+        o = new(pet_type, bark, breed, )
+        OpenAPI.validate_properties(o)
+        return o
     end
 end # type Dog
 
 const _property_types_Dog = Dict{Symbol,String}(Symbol("pet_type")=>"String", Symbol("bark")=>"Bool", Symbol("breed")=>"String", )
 OpenAPI.property_type(::Type{ Dog }, name::Symbol) = Union{Nothing,eval(Base.Meta.parse(_property_types_Dog[name]))}
 
-function check_required(o::Dog)
+function OpenAPI.check_required(o::Dog)
     o.pet_type === nothing && (return false)
     true
 end
 
+function OpenAPI.validate_properties(o::Dog)
+    OpenAPI.validate_property(Dog, Symbol("pet_type"), o.pet_type)
+    OpenAPI.validate_property(Dog, Symbol("bark"), o.bark)
+    OpenAPI.validate_property(Dog, Symbol("breed"), o.breed)
+end
+
 function OpenAPI.validate_property(::Type{ Dog }, name::Symbol, val)
+
+
+
     if name === Symbol("breed")
         OpenAPI.validate_param(name, "Dog", :enum, val, ["Dingo", "Husky", "Retriever", "Shepherd"])
     end
+
 end

test/client/allany/AllAnyClient/src/models/model_Pet.jl

@@ -14,18 +14,24 @@ Base.@kwdef mutable struct Pet <: OpenAPI.APIModel
     pet_type::Union{Nothing, String} = nothing
 
     function Pet(pet_type, )
-        OpenAPI.validate_property(Pet, Symbol("pet_type"), pet_type)
-        return new(pet_type, )
+        o = new(pet_type, )
+        OpenAPI.validate_properties(o)
+        return o
     end
 end # type Pet
 
 const _property_types_Pet = Dict{Symbol,String}(Symbol("pet_type")=>"String", )
 OpenAPI.property_type(::Type{ Pet }, name::Symbol) = Union{Nothing,eval(Base.Meta.parse(_property_types_Pet[name]))}
 
-function check_required(o::Pet)
+function OpenAPI.check_required(o::Pet)
     o.pet_type === nothing && (return false)
     true
 end
 
+function OpenAPI.validate_properties(o::Pet)
+    OpenAPI.validate_property(Pet, Symbol("pet_type"), o.pet_type)
+end
+
 function OpenAPI.validate_property(::Type{ Pet }, name::Symbol, val)
+
 end

test/client/allany/AllAnyClient/src/models/model_TypeWithAllArrayTypes.jl

@@ -23,20 +23,29 @@ Base.@kwdef mutable struct TypeWithAllArrayTypes <: OpenAPI.APIModel
     anyofpets::Union{Nothing, Vector} = nothing # spec type: Union{ Nothing, Vector{AnyOfPets} }
 
     function TypeWithAllArrayTypes(oneofbase, anyofbase, oneofpets, anyofpets, )
-        OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("oneofbase"), oneofbase)
-        OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("anyofbase"), anyofbase)
-        OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("oneofpets"), oneofpets)
-        OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("anyofpets"), anyofpets)
-        return new(oneofbase, anyofbase, oneofpets, anyofpets, )
+        o = new(oneofbase, anyofbase, oneofpets, anyofpets, )
+        OpenAPI.validate_properties(o)
+        return o
     end
 end # type TypeWithAllArrayTypes
 
 const _property_types_TypeWithAllArrayTypes = Dict{Symbol,String}(Symbol("oneofbase")=>"Vector{OneOfBaseType}", Symbol("anyofbase")=>"Vector{AnyOfBaseType}", Symbol("oneofpets")=>"Vector{OneOfPets}", Symbol("anyofpets")=>"Vector{AnyOfPets}", )
 OpenAPI.property_type(::Type{ TypeWithAllArrayTypes }, name::Symbol) = Union{Nothing,eval(Base.Meta.parse(_property_types_TypeWithAllArrayTypes[name]))}
 
-function check_required(o::TypeWithAllArrayTypes)
+function OpenAPI.check_required(o::TypeWithAllArrayTypes)
     true
 end
 
+function OpenAPI.validate_properties(o::TypeWithAllArrayTypes)
+    OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("oneofbase"), o.oneofbase)
+    OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("anyofbase"), o.anyofbase)
+    OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("oneofpets"), o.oneofpets)
+    OpenAPI.validate_property(TypeWithAllArrayTypes, Symbol("anyofpets"), o.anyofpets)
+end
+
 function OpenAPI.validate_property(::Type{ TypeWithAllArrayTypes }, name::Symbol, val)
+
+
+
+
 end

test/client/openapigenerator_petstore_v3/petstore/.openapi-generator/VERSION

@@ -1 +1 @@
-7.0.0-SNAPSHOT
+7.13.0-SNAPSHOT