Use value syntax for @header, and add explode option
#6130
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisradek
requested review from
bterlson,
markcowl,
allenjzhang,
timotheeguerin,
witemple-msft and
AlitzelMendez
as code owners
|
All changed packages have been documented.
|
| @@ -67,37 +66,37 @@ export const namespace = "TypeSpec.Http"; | |||
| export const $header: HeaderDecorator = ( | |||
| context: DecoratorContext, | |||
| entity: ModelProperty, | |||
| headerNameOrOptions?: StringLiteral | Type, | |||
| headerNameOrOptions, | |||
| ) => { | |||
| const options: HeaderFieldOptions = { | |||
| type: "header", | |||
| name: entity.name.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase(), | |||
| }; | |||
| if (headerNameOrOptions) { | |||
There was a problem hiding this comment.
i think we also need to deprecate format
|
You can try these changes here
|
chrisradek
commented
Feb 25, 2025
| @header({ | ||
| format: "csv", | ||
| }) | ||
| @header(#{ format: "csv" }) |
There was a problem hiding this comment.
It doesn't look like this is actually used in any Azure specs. @header isn't called with options in any typespec file in the azure specs repo. I also wrote a regex to look for any header parameter of type array or object, and came up with 0 hits in the azure specs repo.
What we want is for csv to be the default behavior here, but I'm not sure what work is needed on our emitters to make that the case yet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4114
One question is whether to add a new http-specs test for the explode scenarios as part of this PR. Currently there aren't any specs for headers defined as objects - I presume since swagger doesn't allow it.
Related typespec-azure PR: Azure/typespec-azure#2257