CoCoCoCoCoCo / docs
← API reference
Query / jobs

getOperationParameterSchema

Returns the JSON Schema (draft-07) for the parameters field of the given operation kind, or null if no schema is defined for that kind. Use this to drive dynamic form generation on the client. Requires operation:read permission.

Arguments

kindString!

The operation kind to retrieve the parameter schema for

Returns JSON

Explore in a view

Production Floor
View exact SDL
"""
Returns the JSON Schema (draft-07) for the parameters field of the given operation kind, or null if no schema is defined for that kind. Use this to drive dynamic form generation on the client. Requires operation:read permission.
"""
getOperationParameterSchema(
  """The operation kind to retrieve the parameter schema for"""
  kind: String!
): JSON @topic(names: ["jobs"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.