Auto-generate ConfigurationSchema.json for JSON IntelliSense by Copilot · Pull Request #10139 · microsoft/typespec

Copilot · 2026-03-25T19:03:04Z

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Add schema generation for appsettings.json IntelliSense when a client library has ClientSettings. The schema includes well-known client names under 'Clients' (SCM) or 'AzureClients' (Azure) sections, with $ref to shared credential/options definitions and allOf for client-specific option extensions. Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/555ac5bb-bd9c-4d73-90ca-f2922cf55fa5

Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/555ac5bb-bd9c-4d73-90ca-f2922cf55fa5

JoshLove-msft · 2026-03-25T19:27:22Z

...sharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/ConfigurationSchemaGenerator.cs

+
+            // Determine if Azure or SCM based on the options base type namespace.
+            var optionsBaseType = ScmCodeModelGenerator.Instance.TypeFactory.ClientPipelineApi.ClientPipelineOptionsType;
+            bool isAzure = optionsBaseType.Namespace?.StartsWith("Azure", StringComparison.Ordinal) == true;


@copilot we shouldn't have anything related to Azure in the base emitter.

Removed the Azure-specific namespace detection. Generate() now always uses "Clients" and "options" as defaults, with sectionName/optionsRef parameters that a derived emitter can override if needed. Fixed in 3541fb5.

Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/555ac5bb-bd9c-4d73-90ca-f2922cf55fa5

JoshLove-msft · 2026-03-25T19:35:57Z

.chronus/changes/auto-generate-configuration-schema-json-2026-03-25.md

@@ -0,0 +1,29 @@
+---
+changeKind: feature


@copilot delete this file

Deleted in f3f72b7.

…rator The base emitter should not contain Azure-specific code. Removed the namespace-based Azure detection and made Generate() always use "Clients" and "options" as defaults, with parameters allowing overrides by derived emitters. Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/78f8c1a0-1d00-4e19-89d1-e9090dc2aeab

Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/7703f03f-8937-43a3-b716-e0e5f8090658

JoshLove-msft · 2026-03-27T02:50:17Z

@copilot why didn't the regen show a diff since we don't have a ConfigurationSchema.json checked in for the Test Project?

pkg-pr-new · 2026-03-27T02:52:06Z

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-csharp@10139

commit: 8b61ad8

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/54e740be-2cdd-4b28-9516-7744e0fcf1dc Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Copilot · 2026-03-27T03:10:35Z

@copilot why didn't the regen show a diff since we don't have a ConfigurationSchema.json checked in for the Test Project?

I hadn't run Generate.ps1 after adding the feature. Running it now generated 72 schema/ConfigurationSchema.json files across all test projects (Sample-TypeSpec + Spector). Committed in 2c0a31e.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

telemetry.astro.build
- Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/typespec/typespec/website/node_modules/.bin/../astro/bin/astro.mjs build node s/.b�� tput-dir ../../w--llmstxt . .2_tmp_4499_0/no../../website/src/content/docs/docs/emitters/openapi3/reference --import @typespec/librar/home/REDACTED/work/typespec/typespec/packages/http-specs/node_modules�� --no-emit node /nod�� gen-extern-signature sh _modules/.bin/sh node scripts/buinode l/reference n/sh sh (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

JoshLove-msft · 2026-03-27T15:56:51Z

@copilot why didn't the regen show a diff since we don't have a ConfigurationSchema.json checked in for the Test Project?

I hadn't run Generate.ps1 after adding the feature. Running it now generated 72 schema/ConfigurationSchema.json files across all test projects (Sample-TypeSpec + Spector). Committed in 2c0a31e.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

But why didn't the Regen check step fail on the diff then?

Copilot · 2026-03-27T16:02:09Z

@copilot why didn't the regen show a diff since we don't have a ConfigurationSchema.json checked in for the Test Project?

I hadn't run Generate.ps1 after adding the featur...

Check-GitChanges.ps1 uses git diff (line 18), which only detects modifications to tracked files. Since the ConfigurationSchema.json files were brand new (untracked), they were invisible to the diff check. The script would need to also check for untracked files (e.g., via git status --porcelain) to catch newly generated files that aren't yet checked in.

JoshLove-msft · 2026-03-27T16:02:41Z

...p-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/schema/ConfigurationSchema.json

+              "type": "string"
+            },
+            "Credential": {
+              "$ref": "#/definitions/credential"


@copilot where are the definitions?

Added a BuildDefinitions() method that generates the definitions section with credential (authentication configuration with Type property) and options (base ClientPipelineOptions properties including NetworkTimeout and RetryPolicy). All $ref pointers now resolve correctly. Fixed in 27184ed.

JoshLove-msft · 2026-03-27T17:59:53Z

...sharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/ConfigurationSchemaGenerator.cs

+    /// Generates a ConfigurationSchema.json file for JSON IntelliSense support in appsettings.json.
+    /// The schema defines well-known client names and their configuration properties.
+    /// </summary>
+    internal static class ConfigurationSchemaGenerator


@copilot we need to handle the options type inheriting from the core type. Here is an example using Azure options https://github.com/Azure/azure-sdk-for-net/pull/57548/changes

Note we will have a separate PR to handle the Azure config schema, but we need to have the same pattern for the unbranded options.

Each client's options type is now modeled as a named local definition that inherits from the base options type using allOf. For example, SampleTypeSpecClientOptions becomes "sampleTypeSpecClientOptions": { "allOf": [{ "$ref": "#/definitions/options" }] }, and client-specific custom properties (when present) are added in a second allOf element. The client's "Options" property references this local definition via $ref. This matches the pattern from azure-sdk-for-net#57548. Fixed in 3de54bd.

@copilot please add test cases where an options type has additional properties as compared to the base.

@copilot we should also add a test case where an options property contains a model definition.

Added 3 new test cases in 06c5dba:

Generate_OptionsDefinition_IncludesStringProperty — options with a string additional property

Generate_OptionsDefinition_IncludesIntegerProperty — options with an integer additional property

Generate_OptionsDefinition_IncludesMultipleMixedProperties — options with string + boolean + integer additional properties

Each test verifies the allOf pattern has 2 elements (base $ref + extension object with typed properties). All 17 tests pass.

Added GetJsonSchemaForModel that looks up model providers in the output library and creates local definitions with their properties (referenced via $ref). New test Generate_OptionsDefinition_IncludesModelProperty creates a RetryPolicyConfig model with MaxRetries (integer) and Delay (string) properties, then verifies the schema contains a retryPolicyConfig definition with those properties and the options extension references it via $ref. Fixed in 3db3324.

@copilot let's also add a test where the model is a constructor parameter.

Added test Generate_ConstructorParameter_IncludesModelDefinition — creates a ConnectionConfig model (with Host string and Port integer properties) as a required constructor parameter. The test verifies that:

The model appears as a local definitions entry (connectionConfig) with its properties

The model appears as a top-level client property (not under Options) with $ref to the definition

All 19 tests pass. Fixed in 577eac7.

…ions Each client's options type is now defined as a named local definition that inherits from the base 'options' type using allOf. This follows the same pattern used in the Azure emitter (azure-sdk-for-net#57548) where client options types extend the core options type. - Options without custom properties: allOf with single base ref - Options with custom properties: allOf with base ref + extension object - The client's Options property references the local definition via $ref Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/389f65d2-8aed-4cd9-a7cd-29e07b2af4f6 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

…nt, mixed) Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/f557cd05-9182-46bb-806f-405ab81517b9 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

… test Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/f557cd05-9182-46bb-806f-405ab81517b9 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

… type definitions in schema Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/9b678996-629b-4c2f-8a16-918f2026e9d0 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

JoshLove-msft · 2026-03-27T18:44:40Z

@copilot verify that the configurationschema works using local pack of the test project

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/b9941a61-2c64-4fc1-b403-d6313c2ce775 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Copilot · 2026-03-27T18:57:01Z

@copilot verify that the configurationschema works using local pack of the test project

Verified the ConfigurationSchema.json works:

dotnet pack on Sample-TypeSpec succeeds — project builds cleanly with the schema file in the schema/ directory
JSON Schema draft-07 meta-validation passes for all generated schemas (using Python jsonschema library)
Structure validation confirmed:
- All well-known clients have Credential ($ref → #/definitions/credential) and Options ($ref → named local definition)
- Options definitions use allOf to inherit from base options type
- Enum types (e.g., clientType in Spector client-structure tests) are correctly defined with enum values
- additionalProperties on the section allows custom-named instances
Spector test projects with enums also pass validation (e.g., clientType with 5 known values)

@copilot why didn't the regen show a diff since we don't have a ConfigurationSchema.json checked in for the Test Project?

The regen step didn't fail because Check-GitChanges.ps1 originally used only git diff, which doesn't detect new untracked files. This has been fixed — the script now also checks for untracked files via git ls-files --others --exclude-standard (fixed in be700ca).

@copilot why didn't the regen show a diff since we don't have a ConfigurationSchema.json checked in for the Test Project?

I hadn't run Generate.ps1 after adding the featur...

The Regen check step didn't fail because Check-GitChanges.ps1 only used git diff which detects changes to tracked files. Since the ConfigurationSchema.json files were brand new (untracked), they were invisible. This was fixed in be700ca — the script now also checks git ls-files --others --exclude-standard for untracked files.

Check-GitChanges

@copilot let's make that update

Already done in be700ca — Check-GitChanges.ps1 now checks for both tracked modifications (git diff) and untracked files (git ls-files --others --exclude-standard).

jorgerangel-msft · 2026-03-27T20:17:58Z

...sharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/ConfigurationSchemaGenerator.cs

+            // Search for the model provider in the output library
+            var modelProvider = CodeModelGenerator.Instance.OutputLibrary.TypeProviders
+                .SelectMany(t => new[] { t }.Concat(t.NestedTypes))
+                .FirstOrDefault(m => !(m is EnumProvider) && m.Type.Equals(modelType));


should the condition check m is a ModelProvider instead of !(m is EnumProvider) ?

jorgerangel-msft · 2026-03-27T20:19:53Z

...lient-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/ScmCodeModelGenerator.cs

+            if (schemaContent != null)
+            {
+                var schemaPath = Path.Combine(outputPath, "schema", "ConfigurationSchema.json");
+                Directory.CreateDirectory(Path.GetDirectoryName(schemaPath)!);


won't CreateDirectory throw if the path argument is null?

jorgerangel-msft · 2026-03-27T20:27:40Z

...generator/Microsoft.TypeSpec.Generator.ClientModel/test/ConfigurationSchemaGeneratorTests.cs

+            var extensionProperties = allOf!.AsArray()[1]?["properties"];
+            var retryModeProp = extensionProperties!["RetryMode"];
+            Assert.IsNotNull(retryModeProp, "Custom option property should exist");
+            Assert.AreEqual("#/definitions/retryMode", retryModeProp!["$ref"]?.GetValue<string>());


do you think it's worth having a few of these validate against TestData as well?

- Use 'm is ModelProvider' instead of '!(m is EnumProvider)' for more precise type checking in GetJsonSchemaForModel - Add null check for Path.GetDirectoryName result in WriteAdditionalFiles instead of using null-forgiving operator - Add TestData golden file validation for 3 representative tests: Generate_ReturnsSchema_ForClientWithSettings, Generate_ConstructorParameter_IncludesModelDefinition, Generate_HandlesMultipleClients Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-03-27T21:18:18Z

No changes needing a change description found.

Use ReplaceLineEndings to ensure consistent LF line endings across platforms and append trailing newline to match prettier expectations. Regenerated all ConfigurationSchema.json files. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Initial plan

a2aa0dd

Copilot AI assigned Copilot and JoshLove-msft Mar 25, 2026

Copilot started work on behalf of JoshLove-msft March 25, 2026 19:03 View session

microsoft-github-policy-service bot added the emitter:client:csharp Issue for the C# client emitter: @typespec/http-client-csharp label Mar 25, 2026

Address code review feedback: optimize enum lookup and add comments

a1ac5df

Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/555ac5bb-bd9c-4d73-90ca-f2922cf55fa5

JoshLove-msft reviewed Mar 25, 2026

View reviewed changes

Add changelog entry for ConfigurationSchema.json feature

da4dd67

Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/555ac5bb-bd9c-4d73-90ca-f2922cf55fa5

Copilot AI changed the title ~~[WIP] Add auto-generate ConfigurationSchema.json for JSON IntelliSense~~ Auto-generate ConfigurationSchema.json for JSON IntelliSense Mar 25, 2026

Copilot AI requested a review from JoshLove-msft March 25, 2026 19:32

Copilot finished work on behalf of JoshLove-msft March 25, 2026 19:32

Copilot started work on behalf of JoshLove-msft March 25, 2026 19:32 View session

JoshLove-msft reviewed Mar 25, 2026

View reviewed changes

Copilot AI requested a review from JoshLove-msft March 25, 2026 19:38

Copilot finished work on behalf of JoshLove-msft March 25, 2026 19:38

Copilot started work on behalf of JoshLove-msft March 25, 2026 19:38 View session

Delete chronus changelog file per reviewer request

f3f72b7

Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/7703f03f-8937-43a3-b716-e0e5f8090658

Copilot finished work on behalf of JoshLove-msft March 25, 2026 19:52

Copilot started work on behalf of JoshLove-msft March 27, 2026 02:50 View session

Add regenerated ConfigurationSchema.json files for test projects

2c0a31e

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/54e740be-2cdd-4b28-9516-7744e0fcf1dc Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Copilot finished work on behalf of JoshLove-msft March 27, 2026 03:11

Copilot started work on behalf of JoshLove-msft March 27, 2026 15:57 View session

JoshLove-msft reviewed Mar 27, 2026

View reviewed changes

Copilot finished work on behalf of JoshLove-msft March 27, 2026 17:58

JoshLove-msft reviewed Mar 27, 2026

View reviewed changes

Copilot started work on behalf of JoshLove-msft March 27, 2026 18:00 View session

Copilot AI requested a review from JoshLove-msft March 27, 2026 18:22

Copilot finished work on behalf of JoshLove-msft March 27, 2026 18:22

Copilot started work on behalf of JoshLove-msft March 27, 2026 18:24 View session

Copilot AI and others added 2 commits March 27, 2026 18:28

Add test cases for options type with additional properties (string, i…

06c5dba

…nt, mixed) Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/f557cd05-9182-46bb-806f-405ab81517b9 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Add descriptive assertion message for allOf count in integer property…

1d975e4

… test Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/f557cd05-9182-46bb-806f-405ab81517b9 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Copilot finished work on behalf of JoshLove-msft March 27, 2026 18:32

Copilot started work on behalf of JoshLove-msft March 27, 2026 18:32 View session

Add test for options property with model definition and support model…

3db3324

… type definitions in schema Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/9b678996-629b-4c2f-8a16-918f2026e9d0 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Copilot finished work on behalf of JoshLove-msft March 27, 2026 18:47

Copilot started work on behalf of JoshLove-msft March 27, 2026 18:47 View session

JoshLove-msft marked this pull request as ready for review March 27, 2026 18:52

JoshLove-msft requested review from ShivangiReja, christothes, jorgerangel-msft, joseharriaga, jsquire and m-nash as code owners March 27, 2026 18:52

Add test for model as constructor parameter in ConfigurationSchema

577eac7

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/b9941a61-2c64-4fc1-b403-d6313c2ce775 Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Copilot finished work on behalf of JoshLove-msft March 27, 2026 19:01

jorgerangel-msft reviewed Mar 27, 2026

View reviewed changes

jorgerangel-msft approved these changes Mar 27, 2026

View reviewed changes

Conversation

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft commented Mar 27, 2026

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

JoshLove-msft commented Mar 27, 2026

Uh oh!

Copilot AI commented Mar 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft commented Mar 27, 2026

Uh oh!

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Mar 25, 2026 •

edited

Loading

pkg-pr-new bot commented Mar 27, 2026 •

edited

Loading

Copilot AI commented Mar 27, 2026 •

edited

Loading

Copilot AI commented Mar 27, 2026 •

edited

Loading