JSON schema for query parameters?

[soxofaan]

I'm a bit confused by the specification of the partial parameter for https://openeo.org/documentation/1.0/developers/api/reference.html#tag/Data-Processing/operation/list-results

openeo-api/openapi.yaml

Lines 3238 to 3250 in c5a45b4

	parameters:
	- name: partial
	description: >-
	If set to `true`, the results endpoint returns incomplete results while
	still running.
	Enabling this parameter requires to indicate the status of the batch job
	in the STAC metadata by setting the `openeo:status`.
	in: query
	allowEmptyValue: true
	schema:
	type: boolean
	default: false

How does JSON schema applies to query parameters like this? As far as I know query parameters are just strings and the openEO API spec does not mention something about additional or assumed encoding there.

[soxofaan]

So in the case of partial, the value to enable it should be the string "true" instead of the boolean looking true I think.

Same question applies to other query parameters used in other places, like limit which is defined as int

[m-mohr]

Good question, something that I also recently found weird in OGC APIs. But it's a more general question that should be answered by OpenAPI, I guess?

[soxofaan]

Ah good to know this is an upstream issue.

There is a bit of documentation at https://swagger.io/docs/specification/serialization/ but it does not explicitly mention how basic types like boolean, int and floats are to be encoded and decoded. I know it's quite trivial, but still there are details that could get in the way in practice: e.g. naively serializing boolean "true in Python gives True with capital T instead of true which you would get with Javascript I guess (and I bet there are languages that serialize boolans by default as t/f or even 1/0).

[m-mohr]

Did you find a corresponding issue in the OpenAPI issue tracker? If not, could you open one? Would be interesting to know in general and I'm pretty much flying to NY in a couple of minutes ;-)

[soxofaan]

no, I haven't found any further leads about this. If I find some time today I'll try to create an issue