invalid-server-variable

Id

@typespec/openapi3/invalid-server-variable

This diagnostic is issued when a variable in the @server decorator is not defined as a string type. Since server variables are substituted into the server URL, which is a string, all variables must have string values.

How to fix

Make sure all server variables are of a type that is assignable to string.

Incorrect

@server("{protocol}://{host}/api/{version}", "Custom endpoint", {
  protocol: "http" | "https",
  host: string,
  version: 1, // Should be a string: "1"
})

Correct

@server("{protocol}://{host}/api/{version}", "Custom endpoint", {
  protocol: "http" | "https",
  host: string,
  version: "1",
})