feat(typespec-metadata): add apiVersion field using TCGC resolution by iscai-msft · Pull Request #5065 · Azure/typespec-azure

iscai-msft · 2026-07-27T15:03:36Z

Summary

Adds an apiVersion field to the LanguagePackageMetadata interface in packages/typespec-metadata, resolved via createSdkContext from @azure-tools/typespec-client-generator-core.

Changes

src/metadata.ts: Added apiVersion?: string to LanguagePackageMetadata with doc comment explaining possible values
src/emitter.ts: Calls createSdkContext and resolves sdkPackage.metadata.apiVersions map
src/collector.ts: Threads resolvedApiVersion through collectLanguagePackages → buildLanguageMetadata → createLanguageMetadata
package.json: Added @azure-tools/typespec-client-generator-core as "workspace:^" dependency
test/collector.test.ts: Added "apiVersion extraction" describe block with 5 tests

Resolution Logic

Map state	Resolved value
size > 1	`"multiple-versions"`
size == 1	The single value (`"all"` or actual version like `"2023-10-01"`)
empty/undefined	`undefined`

Add apiVersion to LanguagePackageMetadata interface, resolved via createSdkContext from @azure-tools/typespec-client-generator-core. Resolution logic: - Map size > 1 → "multiple-versions" - Map size == 1 → the single value ("all" or actual version string) - Empty/undefined → undefined Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

Add integration tests that compile TypeSpec input and verify the apiVersions map from TCGC, matching the test style in typespec-client-generator-core/test/package/api-versions-metadata.test.ts. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

… output Tests now compile TypeSpec input, run the full emitter, and assert the apiVersion field on the emitted metadata snapshot (not just the TCGC map). Also adds api-version as a passthrough emitter option. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

The e2e tests in api-version.test.ts fully cover apiVersion behavior by testing the actual emitter output. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

praveenkuttappan · 2026-07-27T15:42:26Z

+   * - An actual resolved version string (e.g. `"2023-10-01"`) for a single version
+   * - `undefined` when no API version information is available
+   */
+  apiVersion?: string;


Should this be in language metadata or typespec metadata? Is it possible to have different API version value for each language?

you're right, I guess each language could specify different values in tspconfig.yaml, so it shouldn't be the case but it could be

would you prefer to ignore that possibility and move it to typespec metadata, or keep it where it is in language metadata

Nope. Let's keep it in language metadata. It's easier to parse all get the distinct on the consumer side.

The lockfile was generated with internal registry URLs that fail CI tarball verification. workspace:^ dependencies don't need lockfile changes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

github-actions · 2026-07-27T16:03:05Z

All changed packages have been documented.

✅ @azure-tools/typespec-metadata

Show changes

`@azure-tools/typespec-metadata` - feature ✏️

Add apiVersion field to LanguagePackageMetadata resolved via TCGC's createSdkContext. Values: "all" when configured for all versions, "multiple-versions" for multi-service configs, the actual resolved version string, or undefined when unavailable. Also adds api-version as a passthrough emitter option.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7d63e253-0c42-46ea-88b1-3e0aa1dddebe

pkg-pr-new · 2026-07-27T16:49:02Z

Open in StackBlitz

npm i https://pkg.pr.new/@azure-tools/typespec-metadata@5065

commit: 897c048

…erTester Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

azure-sdk-automation · 2026-07-27T17:05:25Z

You can try these changes here

🛝 Playground	🌐 Website

… for passthrough Remove api-version from MetadataEmitterOptions and its schema since TCGC reads it directly from EmitContext. Set additionalProperties: true so unknown options like api-version pass through in tspconfig without validation errors. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

…data map Read apiVersion directly from sdkContext (which TCGC populates from context.options["api-version"]) to handle the 'all' case. Fall back to resolved apiVersions map for specific version resolution. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 75e5e691-2de3-4305-9855-bee4534c6690

api-version passthrough is not needed — TCGC resolves versions from TypeSpec versioning decorators when no explicit api-version is configured. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 75e5e691-2de3-4305-9855-bee4534c6690

…tadata Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 75e5e691-2de3-4305-9855-bee4534c6690

Add an isPreview boolean field to sdkPackage.metadata so consumers can determine if the SDK targets preview API versions without recomputing from version strings. - true if any targeted API version matches the preview string regex - false if all versions are stable - undefined if no versioning is present Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d3f5528-7e0e-4828-ab85-b85ba9dffc5d

This reverts commit ef4b4bc.

…-carnival # Conflicts: # pnpm-lock.yaml

Resolves whether the SDK targets preview or stable API versions by checking client apiVersions against TCGC's previewStringRegex. The @previewVersion decorator case will be handled once TCGC exposes isPreview on its metadata. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

iscai-msft requested review from bterlson, markcowl and timotheeguerin as code owners July 27, 2026 15:03

iscai-msft force-pushed the iscai-msft-add-apiversion-to-metadata branch from f3029f1 to a532259 Compare July 27, 2026 15:11

iscai-msft force-pushed the iscai-msft-add-apiversion-to-metadata branch from a532259 to 0ce39ea Compare July 27, 2026 15:12

iscai-msft and others added 6 commits July 27, 2026 11:16

chore: update pnpm-lock.yaml for new TCGC peer dependency

b9bf362

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

chore: add changeset for apiVersion feature

427b365

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

style: apply prettier formatting

3a5a9e0

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

praveenkuttappan reviewed Jul 27, 2026

View reviewed changes

timotheeguerin reviewed Jul 27, 2026

View reviewed changes

Comment thread packages/typespec-metadata/test/tester.ts Outdated

iscai-msft force-pushed the iscai-msft-add-apiversion-to-metadata branch from 17f535c to 2a8df3d Compare July 27, 2026 15:58

chore: revert manual lockfile edit (will regenerate in cloud)

0e879fb

chore: regenerate pnpm-lock.yaml for new typespec-metadata deps

75d83ab

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7d63e253-0c42-46ea-88b1-3e0aa1dddebe

refactor: restructure test tester into ApiTester/MetadataTester/Emitt…

897c048

…erTester Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c95a24d5-2785-44e4-9599-ac2f5cb37a2c

iscai-msft and others added 5 commits July 27, 2026 14:47

test: set api-version 'all' on typespec-python instead of typespec-me…

1ed30f1

…tadata Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 75e5e691-2de3-4305-9855-bee4534c6690

iscai-msft requested review from lmazuel, m-nash and xirzec as code owners July 27, 2026 19:18

microsoft-github-policy-service Bot added the lib:tcgc Issues for @azure-tools/typespec-client-generator-core library label Jul 27, 2026

Revert "feat(tcgc): add isPreview to SdkPackageType metadata"

75b4fc4

This reverts commit ef4b4bc.

iscai-msft mentioned this pull request Jul 27, 2026

feat(tcgc): add isPreview to SdkPackageType metadata #5071

Open

Merge remote-tracking branch 'upstream/main' into iscai-msft-stunning…

f82a9fb

…-carnival # Conflicts: # pnpm-lock.yaml

iscai-msft force-pushed the iscai-msft-add-apiversion-to-metadata branch from f89aac7 to f82a9fb Compare July 27, 2026 19:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(typespec-metadata): add apiVersion field using TCGC resolution - #5065

feat(typespec-metadata): add apiVersion field using TCGC resolution#5065
iscai-msft wants to merge 19 commits into
Azure:mainfrom
iscai-msft:iscai-msft-add-apiversion-to-metadata

iscai-msft commented Jul 27, 2026

Uh oh!

praveenkuttappan Jul 27, 2026

Uh oh!

iscai-msft Jul 27, 2026

Uh oh!

iscai-msft Jul 27, 2026

Uh oh!

praveenkuttappan Jul 27, 2026

Uh oh!

Uh oh!

github-actions Bot commented Jul 27, 2026

`@azure-tools/typespec-metadata` - feature ✏️

Uh oh!

pkg-pr-new Bot commented Jul 27, 2026 •

edited

Loading

Uh oh!

azure-sdk-automation Bot commented Jul 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

iscai-msft commented Jul 27, 2026

Summary

Changes

Resolution Logic

Uh oh!

praveenkuttappan Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

iscai-msft Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

iscai-msft Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

praveenkuttappan Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Jul 27, 2026

@azure-tools/typespec-metadata - feature ✏️

Uh oh!

pkg-pr-new Bot commented Jul 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-sdk-automation Bot commented Jul 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`@azure-tools/typespec-metadata` - feature ✏️

pkg-pr-new Bot commented Jul 27, 2026 •

edited

Loading