feat: support for query parameter serialization style "deepObject" #78
Conversation
vdayanand
changed the title
| key = replace(key, r"\[" => '\0') | ||
| key = replace(key, r"\]" => "") | ||
| parts = split(key, '\0') | ||
| keylist = parts |
There was a problem hiding this comment.
Not sure if we should rely on \0. Could the lines above be replaced with: keylist = replace.(split(key, "["), "]"=>"")?
| if !haskey(current, part) | ||
| current[part] = Dict{String, Any}() | ||
| end | ||
| current = current[part] |
There was a problem hiding this comment.
Use get! instead?
current = get!(current, part) do
Dict{String,Any}()
end
| return deserialized_dict | ||
| end | ||
|
|
||
| function deserialize_deep_object(qp::Dict) |
There was a problem hiding this comment.
Should we rename deserialize_deep_object to deep_dict_repr or something? It might be confusing for someone reading the code that it returns a dict and not a struct instance.
| to_param_type(T, json; stylectx) | ||
| end | ||
| else | ||
| to_param_type(T, json; stylectx) |
There was a problem hiding this comment.
to_param_type(::Type{Vector{T}}, should be returning a Vector{T}, no?
Should we be throwing an exception instead?
|
Added client support as well. I will add end to end tests |
vdayanand
changed the title
| deep_explode = style == "deepObject" && is_explode | ||
| if deep_explode | ||
| merge!(params, serialize_to_query_dict(Dict(name=>value))) | ||
| return params |
There was a problem hiding this comment.
set_param should return nothing.
| @@ -292,7 +292,12 @@ function set_header_content_type(ctx::Ctx, ctypes::Vector{String}) | |||
| end | |||
|
|
|||
| set_param(params::Dict{String,String}, name::String, value::Nothing; collection_format=",") = nothing | |||
| function set_param(params::Dict{String,String}, name::String, value; collection_format=",") | |||
| function set_param(params::Dict{String,String}, name::String, value; collection_format=",", style="form", is_explode=false) | |||
| deep_explode = style == "deepObject" && is_explode | |||
There was a problem hiding this comment.
Maybe we should not be checking is_explode if style == "deepObject"? Because as per spec, deepObject seems to imply explode=true always.
| @@ -828,4 +833,21 @@ function extract_filename(resp::Downloads.Response)::String | |||
| return string("response", extension_from_mime(MIME(content_type_str))) | |||
| end | |||
|
|
|||
| function serialize_to_query_dict(dict::Dict, parent_key::String = "") | |||
There was a problem hiding this comment.
Rename method with deepobject_ prefix?
|
|
||
| is_deep_explode(sctx::StyleCtx) = sctx.name == "deepObject" && sctx.is_explode | ||
|
|
||
| function convert_dict_to_array(src::Dict) |
There was a problem hiding this comment.
Rename method with deepobject_ prefix?
Introduction
The
deepObjectstyle is used for complex object serialization in query parameters for OpenAPI 3.0 (https://swagger.io/docs/specification/serialization). This style enables the representation of nested objects particularly suitable for APIs that need to handle hierarchical data structures.Description
The deepObject format represents nested objects and arrays by encoding each level of nesting as a separate query parameter, using square brackets to denote the hierarchy. Each parameter consists of a base key followed by one or more nested keys.
Key Elements
Note: OpenAPI spec doesn't define array de serialization for
deepObject. So basically we have extended it for arraysExamples
a[b][c][d]=value1&a[b][c][e]=value2&a[f]=value3would be intermediately deserialized as{ "a": { "b": { "c": { "d": "value1", "e": "value2" } }, "f": "value3" } }a[b][0]=value1&&a[b][1]=value2would be intermediately deserialized as:{ "a": { "b": [ "value1", "value2" ] } }