Skip to content
aerandil.com
GitHub

Validate Query objects (dry-run)

POST
/v1/functions/hospitality.function.query_objects/validate
curl --request POST \
  --url https://api.aerandil.com/v1/functions/hospitality.function.query_objects/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "params": { "filters": "example", "limit": 1, "object_type": "example" } }'

Dry-run of invoke_hospitality_function_query_objects’s parameter checks. No handler dispatch, no store reads — just parameter shape, target presence, target type, unknown-parameter rejection.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
params
required
object
filters
Conjunctive equality filters as a JSON object {property_api_name: value}
limit
Maximum hits to return (default 50, capped at 200)
integer
object_type
required
Object-type api name to query
string
Examplegenerated
{
  "params": {
    "filters": "example",
    "limit": 1,
    "object_type": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter.

Media typeapplication/json
object
errors

Function-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
function
required
string
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}