add more validations for format and multipleOf

- add validations for `multipleOf`
- add validations for some `format` specifiers for string, number and integer types
- convert to string when numbers are assigned to string types in models, because some languages may send data with numbers when the format specifier for string type allows it

Author: tanmaykm

Project.toml

@@ -4,9 +4,10 @@ keywords = ["Swagger", "OpenAPI", "REST"]
 license = "MIT"
 desc = "OpenAPI server and client helper for Julia"
 authors = ["Tanmay Mohapatra <[email protected]>"]
-version = "0.1.2"
+version = "0.1.3"
 
 [deps]
+Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"

README.md

@@ -54,11 +54,49 @@ Following validations are incorporated into models:
 - minimum length: must be a string value of length greater than or equal to a specified value
 - maximum item count: must be a list value with number of items less than or equal to a specified value
 - minimum item count: must be a list value with number of items greater than or equal to a specified value
+- unique items: items must be unique
+- maximum properties count: number of properties must be less than or equal to a specified value
+- minimum properties count: number of properties must be greater than or equal to a specified value
 - pattern: must match the specified regex pattern
+- format: must match the specified format specifier (see subsection below for details)
 - enum: value must be from a list of allowed values
+- multiple of: must be a multiple of a specified value
 
 Validations are imposed in the constructor and `setproperty!` methods of models.
 
+#### Validations for format specifiers
+
+String, number and integer data types can have an optional format modifier that serves as a hint at the contents and format of the string. Validations for the following OpenAPI defined formats are built in:
+
+| Data Type | Format    | Description |
+|-----------|-----------|-------------|
+| number    | float     | Floating-point numbers. |
+| number    | double    | Floating-point numbers with double precision. |
+| integer   | int32     | Signed 32-bit integers (commonly used integer type). |
+| integer   | int64     | Signed 64-bit integers (long type). |
+| string    | date      | full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 |
+| string    | date-time | the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z |
+| string    | byte      | base64-encoded characters, for example, U3dhZ2dlciByb2Nrcw== |
+
+Validations for custom formats can be plugged in by overloading the `OpenAPI.val_format` method.
+
+E.g.:
+
+```julia
+# add a new validation named `custom` for the number type
+function OpenAPI.val_format(val::AbstractFloat, ::Val{:custom})
+    return true # do some validations and return result
+end
+# add a new validation named `custom` for the integer type
+function OpenAPI.val_format(val::Integer, ::Val{:custom})
+    return true # do some validations and return result
+end
+# add a new validation named `custom` for the string type
+function OpenAPI.val_format(val::AbstractString, ::Val{:custom})
+    return true # do some validations and return result
+end
+```
+
 ### Client APIs
 
 Each client API set is generated into a file named `api_<apiname>.jl`. It is represented as a `struct` and the APIs under it are generated as methods. An API set can be constructed by providing the OpenAPI client instance that it can use for communication.

src/OpenAPI.jl

@@ -1,6 +1,6 @@
 module OpenAPI
 
-using HTTP, JSON, URIs, Dates, TimeZones
+using HTTP, JSON, URIs, Dates, TimeZones, Base64
 
 import Base: getindex, keys, length, iterate
 import JSON: lower

src/json.jl

@@ -61,6 +61,9 @@ function from_json(o::T, name::Symbol, v) where {T <: APIModel}
         setfield!(o, name, str2datetime(v))
     elseif Date <: ftype
         setfield!(o, name, str2date(v))
+    elseif String <: ftype && isa(v, Real)
+        # string numbers can have format specifiers that allow numbers, ensure they are converted to strings
+        setfield!(o, name, string(v))
     else
         setfield!(o, name, convert(ftype, v))
     end
@@ -83,6 +86,10 @@ function from_json(o::T, name::Symbol, v::Vector) where {T <: APIModel}
     else
         if (vtype <: Vector) && (veltype <: OpenAPI.UnionAPIModel)
             setfield!(o, name, map(veltype, v))
+        elseif (vtype <: Vector) && (veltype <: String)
+            # ensure that elements are converted to String
+            # convert is to do the translation to Union{Nothing,String} when necessary
+            setfield!(o, name, convert(ftype, map(string, v)))
         elseif ftype <: OpenAPI.UnionAPIModel
             setfield!(o, name, ftype(v))
         else

src/val.jl

@@ -22,6 +22,24 @@ end
 function val_pattern(val::AbstractString, pattern::Regex)
     return !isnothing(match(pattern, val))
 end
+val_format(val, format) = true   # accept any unhandled format
+val_format(val::Union{AbstractString,Integer,AbstractFloat}, format::AbstractString) = val_format(val, Val(Symbol(format)))
+val_format(val::AbstractString, ::Val{:date}) = str2date(val) isa Date
+val_format(val::AbstractString, ::Val{Symbol("date-time")}) = str2datetime(val) isa DateTime
+val_format(val::AbstractString, ::Val{:byte}) = try
+    base64decode(val)
+    true
+catch
+    false
+end
+val_format(val::Integer, ::Val{:int32}) = (typemin(Int32) <= val <= typemax(Int32))
+val_format(val::Integer, ::Val{:int64}) = (typemin(Int64) <= val <= typemax(Int64))
+val_format(val::AbstractFloat, ::Val{:float}) = (typemin(Float32) <= Float32(val) <= typemax(Float32))
+val_format(val::AbstractFloat, ::Val{:double}) = (typemin(Float64) <= Float64(val) <= typemax(Float64))
+
+function val_multiple_of(val::Real, multiple_of::Real)
+    return isinteger(val / multiple_of)
+end
 
 const MSG_INVALID_API_PARAM = Dict{Symbol,Function}([
     :maximum => (val,excl)->string("must be a value less than ", excl ? "or equal to " : "", val),
@@ -35,6 +53,8 @@ const MSG_INVALID_API_PARAM = Dict{Symbol,Function}([
     :minProperties => (val)->string("number of properties must be greater than or equal to ", val),
     :enum => (lst)->string("value is not from the allowed values ", lst),
     :pattern => (val)->string("value does not match required pattern"),
+    :format => (val)->string("value does not match required format"),
+    :multipleOf => (val)->string("value must be a multiple of ", val),
 ])
 
 const VAL_API_PARAM = Dict{Symbol,Function}([
@@ -49,6 +69,8 @@ const VAL_API_PARAM = Dict{Symbol,Function}([
     :minProperties => val_min_length,
     :pattern => val_pattern,
     :enum => val_enum,
+    :format => val_format,
+    :multipleOf => val_multiple_of,
 ])
 
 function validate_param(param, operation_or_model, rule, value, args...)

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

@@ -3,7 +3,8 @@
 
 
 
-@doc raw"""
+@doc raw"""AnyOfMappedPets
+
     AnyOfMappedPets(; value=nothing)
 """
 mutable struct AnyOfMappedPets <: OpenAPI.AnyOfAPIModel

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

@@ -3,7 +3,8 @@
 
 
 
-@doc raw"""
+@doc raw"""AnyOfPets
+
     AnyOfPets(; value=nothing)
 """
 mutable struct AnyOfPets <: OpenAPI.AnyOfAPIModel

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

@@ -2,7 +2,8 @@
 # Do not modify this file directly. Modify the OpenAPI specification instead.
 
 
-@doc raw"""
+@doc raw"""Cat
+
     Cat(;
         pet_type=nothing,
         hunts=nothing,

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

@@ -2,7 +2,8 @@
 # Do not modify this file directly. Modify the OpenAPI specification instead.
 
 
-@doc raw"""
+@doc raw"""Cat_allOf
+
     CatAllOf(;
         hunts=nothing,
         age=nothing,

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

@@ -2,7 +2,8 @@
 # Do not modify this file directly. Modify the OpenAPI specification instead.
 
 
-@doc raw"""
+@doc raw"""Dog
+
     Dog(;
         pet_type=nothing,
         bark=nothing,