SerenAI

Pay Per Call Agentic Commerce

QueryParamDefinition

Query parameter definition for an endpoint

Properties

PropertyTypeRequiredDescription
description string,null No Human-readable description
example string,null No Example value for documentation
name string Yes Parameter name (e.g., "id", "limit")
param_type ParamType No Parameter type
required boolean No Whether this parameter is required
View JSON Schema
{
  "type": "object",
  "description": "Query parameter definition for an endpoint",
  "required": [
    "name"
  ],
  "properties": {
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Human-readable description"
    },
    "example": {
      "type": [
        "string",
        "null"
      ],
      "description": "Example value for documentation"
    },
    "name": {
      "type": "string",
      "description": "Parameter name (e.g., \"id\", \"limit\")"
    },
    "param_type": {
      "$ref": "#/components/schemas/ParamType",
      "description": "Parameter type"
    },
    "required": {
      "type": "boolean",
      "description": "Whether this parameter is required"
    }
  }
}