Skip to content

header-parameter-format-not-supported

Id
@azure-tools/typespec-java/header-parameter-format-not-supported

Severity: warning

This diagnostic is issued when an array-valued header uses any collection format other than CSV. The Java emitter supports only comma-delimited arrays for header parameters.

Impact

Section titled “Impact”

The requested header serialization format is ignored, which can produce a request that does not match the service contract.

❌ Incorrect Usage

Section titled “❌ Incorrect Usage”
op read(
  @header
  @encode(ArrayEncoding.pipeDelimited)
  values: string[],
): void;

Diagnostic Message

Section titled “Diagnostic Message”
Header parameter format '<format>' is not supported.

✅ How to Fix

Section titled “✅ How to Fix”

Use the default comma-delimited header representation.

op read(@header values: string[]): void;

Suppression

Section titled “Suppression”

This warning should not be suppressed. Change the service contract or header encoding to CSV.