← API reference
CANONICAL TYPE REFERENCE

APIClientParameterInput

Typed parameter amendment pinned to the uploaded schema.

locationString!

path, query or header

nameString!

Stable Lua binding or declared field name.

actionString!

add, replace or remove

typeString

string, integer, number, boolean or array

itemTypeString

Required scalar element type for arrays

csv, ssv, tsv, pipes or multi; subject to location rules

requiredBoolean

Whether callers must supply this parameter.

View exact SDL
"""Typed parameter amendment pinned to the uploaded schema."""
input APIClientParameterInput {
  """path, query or header"""
  location: String!
  """Stable Lua binding or declared field name."""
  name: String!
  """add, replace or remove"""
  action: String!
  """string, integer, number, boolean or array"""
  type: String
  """Required scalar element type for arrays"""
  itemType: String
  """csv, ssv, tsv, pipes or multi; subject to location rules"""
  collectionFormat: String
  """Whether callers must supply this parameter."""
  required: Boolean
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.