fix set_param - Githubissues

jonalm commented 8 months ago

I do not know how this is indended to work, so I don't know if this fix is general or only works in my case.

tanmaykm commented 8 months ago

Could you give some more context, regarding what is the issue you faced?

jonalm commented 7 months ago

Hi @tanmaykm , sorry for the delayed response. Here comes some more context.

The current implementation of set_param fails when value is of type Dict. It hits string directly. string(Dict("a"=>3)) results in Dict(\"a\" => 3). This string representation is further propagated to the query string.

I do not know if there is an official way to handle Dict like objects by the OpenAPI spec, but the code generated here (https://github.com/jonalm/BenchlingRestApi.jl) seems to indicate that the proper way to handle the dict params in the query string is to set a paramete per item in the dict and to prepend the key value by the $(name). value in the set_param function. At least that is needed for the behavior of this function call https://github.com/jonalm/BenchlingRestApi.jl/blob/0294435467c1d57124d2d85956d383839fc3dd21/codegen/src/apis/api_CustomEntitiesApi.jl#L229C1-L229C99 to be consistent with the associated rest API.

For the particular function linked above, and this code example:

schema_id = "ts_GiD1yWEx"
schema_fields = Dict("from_entity"=> "bfi_mysPWbDJ", "type"=> "sfso_l5yLxYkM")
returning="customEntities.fields.to_entity.value, customEntities.fields.type.value"
api_return, http_resp = list_custom_entities(client; schema_id, schema_fields, returning)

The resulting query string is given by the code before this pr as (see the Dict being interpolated into the string):

v2/custom-entities?schemaId=ts_GiD1yWEx&returning=customEntities.fields.to_entity.value%2C%20customEntities.fields.type.value&schemaField=Dict%28%22from_entity%22%20%3D%3E%20%22bfi_mysPWbDJ%22%2C%20%22type%22%20%3D%3E%20%22sfso_l5yLxYkM%22%29

which gives 400 Bad Request Error.

Whereas, with the changes proposed here, the resulting query string is:

api/v2/custom-entities?schemaId=ts_GiD1yWEx&schemaField.type=sfso_l5yLxYkM&returning=customEntities.fields.to_entity.value%2C%20customEntities.fields.type.value&schemaField.from_entity=bfi_mysPWbDJ

which works.

jonalm commented 7 months ago

On second thought I am a bit unsure about the '$(name).' prefix I think it is specific to my case and not general (i.e. that prefix should be put explicitly into the input dict).

codecov-commenter commented 7 months ago

Codecov Report

Attention: Patch coverage is 50.00000% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 80.63%. Comparing base (1916168) to head (848c589).

Files	Patch %	Lines
src/client.jl	50.00%	2 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #68 +/- ## ========================================== - Coverage 81.74% 80.63% -1.11% ========================================== Files 7 6 -1 Lines 619 594 -25 ========================================== - Hits 506 479 -27 - Misses 113 115 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.