Allow `@encode(string)` on boolean, define case-insensitive `true|false` string semantics, and add Spector coverage + generic string matcher support by Copilot · Pull Request #10875 · microsoft/typespec

Copilot · 2026-06-03T16:26:03Z

@encode(string) was restricted to numeric targets, blocking APIs that model booleans as strings (for example "true" / "false" in payloads or query values). This change extends support to boolean targets, clarifies the docs contract, and adds http-specs Spector coverage.

Compiler validation
- Relaxed @encode validation so the implicit string encoding path (@encode(string)) is valid for boolean in addition to numeric.
- Updated related diagnostic wording to reflect numeric-or-boolean applicability.
Standard library/docs contract
- Updated @encode decorator docs to state boolean string encoding uses case-insensitive true / false values.
- Added a boolean-focused @encode(string) example.
- Removed parsing-specific wording from the boolean string semantics text.
Coverage
- Added a focused compiler decorator test that validates @encode(string) on a boolean model property.
- Updated the non-supported-type expectation to match the new allowed target set.
- Added/updated Spector coverage in packages/http-specs/specs/encode/boolean with matching mock API and regenerated packages/http-specs/spec-summary.md.
- Boolean property scenarios now cover multiple casings/values via:
  - /encode/boolean/property/true-lower
  - /encode/boolean/property/false-lower
  - /encode/boolean/property/true-upper
  - /encode/boolean/property/false-mixed
- Updated boolean mock API request validation to use a standard matcher so request boolean-string values are accepted case-insensitively (true/false), while still returning varied response casings for coverage.
Spector standard matcher support
- Added a built-in generic string matcher in @typespec/spec-api: match.string.caseInsensitive(string).
- Replaced the encode/boolean scenario’s local custom matcher with this shared matcher (match.string.caseInsensitive(String(requestValue))).
- Added matcher unit tests under packages/spec-api/test/matchers/string.test.ts.

model FeatureFlags {
  @encode(string)
  enabled: boolean;
}

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot · 2026-06-05T17:08:37Z

@copilot need to regenerate the definitions

git status --porcelain
ERROR: Files above were changed during PR validation, but not included in the PR.
...

Fixed in f095d13: I regenerated compiler definitions (pnpm gen-compiler-extern-signature) and committed the updated packages/compiler/generated-defs/TypeSpec.ts. I also ran package builds during validation (@typespec/compiler, @typespec/spec-api, and repository pnpm build).

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot · 2026-06-05T17:16:38Z

@copilot formatting also failing run formatter

Fixed in 7d5c391. I ran the formatter and committed the formatting updates for the two files flagged by CI; pnpm run format:check now passes.

timotheeguerin · 2026-06-05T17:22:24Z

@copilot add changelogs

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot · 2026-06-05T17:26:31Z

@copilot add changelogs

Fixed in c58089f. I added the Chronus changelog entry covering @typespec/compiler, @typespec/spec-api, and @typespec/http-specs, and chronus verify --since main now passes.

github-actions · 2026-06-24T13:48:54Z

All changed packages have been documented.

✅ @typespec/compiler
✅ @typespec/http-specs
✅ @typespec/spec-api

Show changes

`@typespec/compiler` - feature ✏️

Allow @encode(string) on boolean targets, define case-insensitive true/false string semantics, and add shared case-insensitive string matcher support with encode/boolean Spector coverage.,> ,> tsp,> model FeatureFlags {,> @encode(string),> enabled: boolean;,> },>

`@typespec/spec-api` - feature ✏️

Allow @encode(string) on boolean targets, define case-insensitive true/false string semantics, and add shared case-insensitive string matcher support with encode/boolean Spector coverage.,> ,> tsp,> model FeatureFlags {,> @encode(string),> enabled: boolean;,> },>

`@typespec/http-specs` - feature ✏️

Allow @encode(string) on boolean targets, define case-insensitive true/false string semantics, and add shared case-insensitive string matcher support with encode/boolean Spector coverage.,> ,> tsp,> model FeatureFlags {,> @encode(string),> enabled: boolean;,> },>

timotheeguerin · 2026-06-24T16:43:20Z

@copilot need to regen docs

website/src/content/docs/docs/standard-library/built-in-decorators.md

shows as modified.

Also show an example of usage in the changelog entry as per comment

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot · 2026-06-24T16:50:29Z

@copilot need to regen docs

website/src/content/docs/docs/standard-library/built-in-decorators.md

...

Done in da8cac9. I regenerated the docs so website/src/content/docs/docs/standard-library/built-in-decorators.md is included, and I updated the changelog entry to include a TypeSpec usage example.

… fix boolean-as-string encoding (microsoft#11087) Adds Python SDK mock API test coverage for the `encode/boolean` Spector scenarios from microsoft#10875 (`@encode(string)` on boolean types). This required updating multiple layers of the Python codegen stack. ## Generator fixes **`types.ts` — property emission** Preserves boolean `@encode(string)` metadata from the compiler and maps it to the Python runtime’s `"str"` format token. **`primitive_types.py` — `BooleanType`** Detects `yaml_data["encode"] == "string"` and sets `self.encode = "str"`, mirroring `IntegerType`. **`model_base.py.jinja2`** Adds `_deserialize_bool_as_str` for case-insensitive string-to-boolean deserialization: ```python def _deserialize_bool_as_str(attr: str) -> bool: return attr.lower() == "true" ``` Also dispatches to it when `annotation is bool and rf._format == "str"`. ## Test coverage Adds sync and async tests for Azure and unbranded clients covering: - `trueLower` — `"true"` → `True` - `falseLower` — `"false"` → `False` - `trueUpper` — `"TRUE"` → `True` - `falseMixed` — `"FaLsE"` → `False` ## Dependencies - Uses `@typespec/compiler` 1.14, which supports boolean `@encode(string)`. - Uses `@typespec/http-specs` `0.1.0-alpha.39`, containing the `encode/boolean` scenarios. - Adds `encode/boolean` to `regenerate-common.ts`. ## Code diff: Azure/azure-sdk-for-python#48067 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>

weidongxu-microsoft · 2026-07-20T09:19:39Z

Any service uses it?

When asking agent to impl in Java emitter (thought it be an easy fix, but...), it instead sees TCGC support is not yet ready. If this is true, TCGC require some work first.
Azure/typespec-azure#4961

<-- never mind, TCGC is doing a fix

Initial plan

0fb96cb

Copilot AI assigned Copilot and timotheeguerin Jun 3, 2026

Copilot started work on behalf of timotheeguerin June 3, 2026 16:26 View session

Copilot AI linked an issue Jun 3, 2026 that may be closed by this pull request

Encode decorator applicable to boolean #10630

Closed

3 tasks

feat(compiler): allow @encode(string) on boolean

26d634d

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

microsoft-github-policy-service Bot added compiler:core Issues for @typespec/compiler meta:website TypeSpec.io updates labels Jun 3, 2026

Copilot AI changed the title ~~[WIP] Update encode decorator to support boolean values~~ Allow @encode(string) on boolean and define true|false string semantics Jun 3, 2026

Copilot finished work on behalf of timotheeguerin June 3, 2026 16:36

Copilot AI requested a review from timotheeguerin June 3, 2026 16:36

timotheeguerin reviewed Jun 3, 2026

View reviewed changes

Comment thread website/src/content/docs/docs/standard-library/built-in-decorators.md Outdated

Copilot started work on behalf of timotheeguerin June 3, 2026 16:45 View session

docs: simplify boolean @encode(string) wording

dbd1269

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot finished work on behalf of timotheeguerin June 3, 2026 16:48

Copilot AI requested a review from timotheeguerin June 3, 2026 16:48

timotheeguerin reviewed Jun 3, 2026

View reviewed changes

Comment thread packages/compiler/generated-defs/TypeSpec.ts

Copilot started work on behalf of timotheeguerin June 3, 2026 17:47 View session

test(http-specs): add boolean @encode(string) spector scenario

8237396

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

microsoft-github-policy-service Bot added the lib:http-specs For issues/prs related to the @typespec/http-specs package label Jun 3, 2026

test(http-specs): refine boolean encode scenario naming

ab2b2d1

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

timotheeguerin reviewed Jun 3, 2026

View reviewed changes

Comment thread packages/http-specs/specs/encode/numeric/main.tsp Outdated

Copilot AI and others added 2 commits June 3, 2026 18:06

test(http-specs): clarify boolean string encode route

2e01d67

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

test(http-specs): move boolean encode scenario to encode/boolean

1f88780

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot AI changed the title ~~Allow @encode(string) on boolean and define true|false string semantics~~ Allow @encode(string) on boolean, define true|false string semantics, and add Spector coverage Jun 3, 2026

Copilot finished work on behalf of timotheeguerin June 3, 2026 18:09

Copilot AI requested a review from timotheeguerin June 3, 2026 18:09

Copilot started work on behalf of timotheeguerin June 3, 2026 18:09 View session

timotheeguerin reviewed Jun 3, 2026

View reviewed changes

Comment thread packages/http-specs/specs/encode/boolean/main.tsp Outdated

Address encode boolean docs and scenario feedback

d015290

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot finished work on behalf of timotheeguerin June 5, 2026 17:09

Copilot started work on behalf of timotheeguerin June 5, 2026 17:09 View session

style: format boolean encode spec and string matcher tests

7d5c391

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot finished work on behalf of timotheeguerin June 5, 2026 17:17

Copilot started work on behalf of timotheeguerin June 5, 2026 17:22 View session

chore: add chronus changelog entries for encode boolean updates

c58089f

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot finished work on behalf of timotheeguerin June 5, 2026 17:26

microsoft-github-policy-service Bot added the stale Mark a PR that hasn't been recently updated and will be closed. label Jun 23, 2026

markcowl approved these changes Jun 23, 2026

View reviewed changes

Comment thread .chronus/changes/copilot-encode-string-boolean-changelog-2026-6-5-17-25-0.md

Merge branch 'main' into copilot/relax-encode-for-boolean

2344e9a

Copilot started work on behalf of timotheeguerin June 24, 2026 16:44 View session

chore: regen docs and add changelog example

da8cac9

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Merge branch 'main' into copilot/relax-encode-for-boolean

1bc774d

Copilot finished work on behalf of timotheeguerin June 24, 2026 16:51

markcowl approved these changes Jun 24, 2026

View reviewed changes

timotheeguerin added this pull request to the merge queue Jun 24, 2026

Merged via the queue into main with commit 85ff828 Jun 24, 2026
28 checks passed

timotheeguerin deleted the copilot/relax-encode-for-boolean branch June 24, 2026 18:23

msyyc mentioned this pull request Jun 24, 2026

[python] add test case for https://github.com/microsoft/typespec/pull/10875 #11086

Open

Copilot AI mentioned this pull request Jun 24, 2026

feat(http-client-python): add encode/boolean Spector mock API tests + fix boolean-as-string encoding #11087

Merged

Uh oh!

Conversation

Copilot AI commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jun 5, 2026

Uh oh!

Copilot AI commented Jun 5, 2026

Uh oh!

timotheeguerin commented Jun 5, 2026

Uh oh!

Copilot AI commented Jun 5, 2026

Uh oh!

Uh oh!

github-actions Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

@typespec/compiler - feature ✏️

@typespec/spec-api - feature ✏️

@typespec/http-specs - feature ✏️

Uh oh!

timotheeguerin commented Jun 24, 2026

Uh oh!

Copilot AI commented Jun 24, 2026

Uh oh!

Uh oh!

weidongxu-microsoft commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jun 3, 2026 •

edited

Loading

github-actions Bot commented Jun 24, 2026 •

edited

Loading

`@typespec/compiler` - feature ✏️

`@typespec/spec-api` - feature ✏️

`@typespec/http-specs` - feature ✏️

weidongxu-microsoft commented Jul 20, 2026 •

edited

Loading