Fix: Invalid example for @header decorator

[bitfl0wer]

The current documentation for the @header HTTP decorator contains an example which has been valid in v0.6.x, but is not valid in v1.0.0 of TypeSpec.

The current, live example yields the following error:

[{
	"owner": "_generated_diagnostic_collection_name_#0",
	"code": "invalid-argument",
	"severity": 8,
	"message": "Argument of type '{ name: \"header-name\", format: \"csv\" }' is not assignable to parameter of type 'string | TypeSpec.Http.HeaderOptions'",
	"source": "TypeSpec",
	"startLineNumber": 31,
	"startColumn": 21,
	"endLineNumber": 31,
	"endColumn": 72
}]

This PR removes the deprecated "format" key from the example, fixing the issue.

[bitfl0wer]

@microsoft-github-policy-service agree

[timotheeguerin]

Thanks!

[github-actions]

All changed packages have been documented.

• ✅ @typespec/http

Show changes

@typespec/http - fix ✏️

Fix: Invalid example for @header decorator

[bitfl0wer]

Boop, this is still open 🫵

[timotheeguerin]

@bitfl0wer the CI is failling, I believe its because the decorator generated TS signatures also need to be updated with the new content. If you run a pnpm build it will do that.