Azure / Azure/typespec-azure

[Discussion] How to check `@Http.Private.includeInapplicableMetadataInPayload`

Open
#3,185 1 comment 1 reaction 2 assignees Claimed by @tadelesh View on GitHub
lib:tcgc
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

It relates to issue https://github.com/Azure/typespec-azure/issues/3179
At present, all SDK emitter does not include property of `@path` or `@query` in response body. As an attempt to solve this issue in SDK emitter, we tried to change the code to include property of `@path` or `@query` in response body.

But then, we encountered the inconsistency from this `@Http.Private.includeInapplicableMetadataInPayload`.

A few [ARM resources](https://github.com/Azure/typespec-azure/blob/main/packages/typespec-azure-resource-manager/lib/models.tsp#L66-L67) are decorated with this decorator,

And typespec-autorest will not include property of `@path` or `@query` for them.
Its impl uses `metadataInfo.isPayloadProperty`
https://github.com/Azure/typespec-azure/blob/bf889cb66efc41cf733f796f40c2784de291cc0b/packages/typespec-autorest/src/openapi.ts#L1971-L1979
[isPayloadProperty](https://github.com/weidongxu-microsoft/typespec/blob/4fd451fb69dfca4fcb54e01358c6823befe11b9f/packages/http/src/metadata.ts#L667)

As SDK emitter, we'd like to know, whether we also need to use this `metadataInfo.isPayloadProperty`?

If yes, we likely need some change in TCGC to give this information to emitters.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.