Interface ParameterRequirement

interface ParameterRequirement {
    description?: string;
    kind: "parameter";
    minServerVersion: SemanticVersion;
    parameterLocation: string;
    parameterName: string;
    route: string;
}

Index

Properties

description? kind minServerVersion parameterLocation parameterName route

Properties

`Optional`description

description?: string

Optional human-readable description override.

kind

kind: "parameter"

minServerVersion

minServerVersion: SemanticVersion

Minimum Phoenix server version as [major, minor, patch].

parameterLocation

parameterLocation: string

Location of the parameter (e.g. "query", "path", "header").

parameterName

parameterName: string

Name of the query/path/header parameter.

route

route: string

The route this parameter belongs to (e.g. "GET /v1/projects/{id}/spans").