[typespec-go] Always document raw JSON fields emitted as []byte

[Copilot]

Fields typed as unknown are emitted as []byte when rawjson-as-bytes is enabled, expecting the caller to marshal a data structure into the bytes. The emitter noted "The contents of this field are raw JSON." only when a field had no other doc, so any raw-JSON field carrying its own @doc gave no hint that the []byte must contain raw JSON.

Changes

• src/codegen/core/models.ts: Append the raw-JSON note for every rawJSON-kind field instead of using it as a fallback description. Follows the existing constant-value pattern — appended on a new line when a description already exists, standalone otherwise.
• test/unittest/scenarios/rawjson-as-bytes.md: Added a documented raw-JSON field to cover the appended-note case.
• .chronus: fix changelog entry for @azure-tools/typespec-go.

Result

type ContainsRawJSON struct {
	// REQUIRED; The contents of this field are raw JSON.
	Anything1 []byte

	// Additional properties supplied by the caller.
	// The contents of this field are raw JSON.
	Extras []byte
}

• Fixes Add doc comment for fields that are raw JSON #4950

[azure-pipelines]

Azure Pipelines:
2 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

[github-actions]

All changed packages have been documented.

• ✅ @azure-tools/typespec-go

Show changes

@azure-tools/typespec-go - fix ✏️

Always document raw JSON fields (emitted as []byte) so callers know to marshal their data structure into the bytes.

[github-actions]

Go emitter diff

Baseline gh:f4ad548c39ac22e47f1f98e574b774fb61460fbd vs this PR.

No changes to generated output.

Rendered diff: inline on the run summary, or the emitter-diff-go-html artifact.

Informational check (core/eng/emitter-diff); does not block the PR.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@azure-tools/typespec-go@5073

commit: 43587fd

[azure-sdk-automation]

You can try these changes here

🛝 Playground	🌐 Website

[jhendrixMSFT]

Can we keep the original message please. It's less delta and is "direction agnostic" (un/marshal).

Have we looked at some examples where this is appended to existing docs?

[JiaqiZhang-Dev]

@copilot revert the description to the original version: The contents of this field are raw JSON.

[Copilot]

Reverted the message back to The contents of this field are raw JSON. in 30d3b13. The scenario snapshot shows it appended after existing docs, e.g.:

// Additional properties supplied by the caller.
// The contents of this field are raw JSON.
Extras []byte

[Copilot]

Correction: the revert is in commit aa2ec5f (not the hash I posted above).

[JiaqiZhang-Dev]

@jhendrixMSFT Yes. Across spec repo, only two services set rawjson-as-bytes: true(monitor/data-plane/Ingestion and monitor/data-plane/OperationalInsights), and both emit into the same package azlogs. So azlogs is the one real package that exercises this path today, and it does have raw-JSON []byte fields that already carry their own doc.

tsp: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/monitor/data-plane/OperationalInsights/models.tsp#L43
sdk: https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/monitor/query/azlogs/models.go#L108

The docs seem to indicate that the content is in JSON format, so I also want to confirm the context of this issue: do we always need to emit the comment, even if the field already has one?