adds support for overlays by kilifu · Pull Request #6753 · microsoft/kiota

kilifu · 2025-07-11T16:45:44Z

add overlays option
caching overlay seams ok
cleanup
ad d BinkyLabs.OpenApi.Overlays

Copilot

Pull Request Overview

Adds support for processing overlay definitions during client and plugin generation, including command‐line options, server RPC methods, and document application logic.

Introduced an overlays option/property throughout TypeScript and C# generation interfaces
Extended Kiota CLI commands and handlers to accept and propagate overlays
Enhanced OpenApiDocumentDownloadService to read, apply, and merge overlay documents, plus added unit tests

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
vscode/packages/npm-package/types.ts	Added `overlays` to generation configuration types
vscode/packages/npm-package/lib/generatePlugin.ts	Propagate `overlays` into plugin generation API and docs
vscode/packages/npm-package/lib/generateClient.ts	Propagate `overlays` into client generation API and docs
tests/Kiota.Builder.Tests/OpenApiDocumentDownloadServiceTests.cs	Added tests for overlay handling in document downloader
src/kiota/Rpc/Server.cs	Updated RPC `GenerateAsync` methods to include `overlays` parameter
src/kiota/Rpc/IServer.cs	Updated interface signatures to include `overlays`
src/kiota/KiotaPluginCommands.cs	Added `--overlays` option for plugin commands
src/kiota/KiotaHost.cs	Added `--overlays` option for `generate` command
src/kiota/KiotaClientCommands.cs	Added `--overlays` option for client commands
src/kiota/Handlers/Plugin/EditHandler.cs	Wired up `OverlaysOption` in plugin edit handler
src/kiota/Handlers/Plugin/AddHandler.cs	Wired up `OverlaysOption` in plugin add handler
src/kiota/Handlers/KiotaGenerateCommandHandler.cs	Wired up `OverlaysOption` for `generate` handler
src/kiota/Handlers/Client/EditHandler.cs	Wired up `OverlaysOption` in client edit handler
src/kiota/Handlers/Client/AddHandler.cs	Wired up `OverlaysOption` in client add handler
src/Kiota.Builder/OpenApiDocumentDownloadService.cs	Implemented overlay document loading and application
src/Kiota.Builder/Lock/KiotaLock.cs	Added `Overlays` to lock file serialization
src/Kiota.Builder/Kiota.Builder.csproj	Added NuGet package reference for overlays support
src/Kiota.Builder/Configuration/GenerationConfiguration.cs	Added `Overlays` property and included in clone

Comments suppressed due to low confidence (2)

vscode/packages/npm-package/lib/generateClient.ts:55

Update the docstring for overlays to accurately describe that it is a list of overlay file paths or URLs to apply, e.g., 'List of overlay definitions to apply during client generation.'

 * @param {string[]} [clientGenerationOptions.overlays] - Whether the generated client uses overlays.

src/kiota/Rpc/Server.cs:180

[nitpick] Use the local configuration variable consistently instead of Configuration.Generation to keep assignments uniform within this method.

            configuration.Overlays = new(overlays);

Copilot · 2025-07-11T18:06:13Z

tests/Kiota.Builder.Tests/OpenApiDocumentDownloadServiceTests.cs

+        var fakeLogger = new FakeLogger<OpenApiDocumentDownloadService>();
+
+
+        var overlaysPath = Path.GetRandomFileName() + "overlays.yaml";


Ensure the target directory exists before writing the overlay file and use Path.Combine(workingDirectory, "overlays.yaml") for correct filepath; consider calling Directory.CreateDirectory first.

Suggested change

var overlaysPath = Path.GetRandomFileName() + "overlays.yaml";

var workingDirectory = Path.Combine(Path.GetTempPath(), "Overlays");

Directory.CreateDirectory(workingDirectory);

var overlaysPath = Path.Combine(workingDirectory, "overlays.yaml");

Copilot · 2025-07-11T18:06:13Z

tests/Kiota.Builder.Tests/OpenApiDocumentDownloadServiceTests.cs

+        if (Directory.Exists(overlaysPath))
+            Directory.Delete(overlaysPath, true);


This check uses Directory.Exists on a file path. Switch to File.Exists(overlaysPath) and delete with File.Delete to clean up the overlay file correctly.

Suggested change

if (Directory.Exists(overlaysPath))

Directory.Delete(overlaysPath, true);

if (File.Exists(overlaysPath))

File.Delete(overlaysPath);

src/kiota/Rpc/IServer.cs

Copilot · 2025-07-11T18:06:14Z

src/Kiota.Builder/Configuration/GenerationConfiguration.cs

            DisableSSLValidation = DisableSSLValidation,
            ExportPublicApi = ExportPublicApi,
            PluginAuthInformation = PluginAuthInformation,
+            Overlays = Overlays


The clone method assigns the same Overlays instance rather than copying it. Change to Overlays = Overlays.ToHashSet(StringComparer.OrdinalIgnoreCase) to avoid shared mutable state.

Suggested change

Overlays = Overlays

Overlays = Overlays?.ToHashSet(StringComparer.OrdinalIgnoreCase)

src/Kiota.Builder/OpenApiDocumentDownloadService.cs

Copilot · 2025-07-11T18:06:15Z

src/Kiota.Builder/OpenApiDocumentDownloadService.cs

+            // TODO : handle multiple Overlays
+            var overlay = config.Overlays.First();


[nitpick] Either implement support for multiple overlays or remove/update this TODO with a clearer next step to avoid stale comments.

Suggested change

// TODO : handle multiple Overlays

var overlay = config.Overlays.First();

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

src/kiota/KiotaPluginCommands.cs

src/Kiota.Builder/Configuration/GenerationConfiguration.cs

baywet · 2025-07-12T15:56:51Z

src/kiota/Rpc/Server.cs

            configuration.Deserializers = deserializers.ToHashSet(StringComparer.OrdinalIgnoreCase);
        if (structuredMimeTypes is { Length: > 0 })
            configuration.StructuredMimeTypes = new(structuredMimeTypes);
+        if (overlays is { Length: > 0 })


Why the difference in implementation between the two methods

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

src/kiota/KiotaPluginCommands.cs

kilifu added 5 commits July 8, 2025 13:01

add overlays option

7baa30f

caching overlay seams ok

a1f6e9d

cleanup

7878482

merge from main

2d4160e

ad d BinkyLabs.OpenApi.Overlays

5cf8682

sebastienlevert requested a review from Copilot July 11, 2025 18:04

Copilot AI reviewed Jul 11, 2025

View reviewed changes

chore: fixes nullable information

5df7c2e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

baywet reviewed Jul 12, 2025

View reviewed changes

baywet and others added 2 commits July 12, 2025 11:57

chore: makes a copy of the overlays hashset when cloning

7a3c003

chore: removes extraneous import

695e5d0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

baywet reviewed Jul 12, 2025

View reviewed changes

src/kiota/KiotaPluginCommands.cs Outdated Show resolved Hide resolved

baywet and others added 7 commits July 12, 2025 12:00

chore: removes extraneous method

d475ceb

uniformisation

0906247

Merge branch 'main' into Feat/add-overlays

6a17845

updqte binkyLabs nugget

42d3812

fix test

e9342a9

test mutliple overlays

93623bb

Merge branch 'main' into Feat/add-overlays

c928465

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds support for overlays#6753

adds support for overlays#6753
kilifu wants to merge 15 commits intomicrosoft:mainfrom
kilifu:Feat/add-overlays

kilifu commented Jul 11, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 11, 2025

Uh oh!

Copilot AI Jul 11, 2025

Uh oh!

Uh oh!

Copilot AI Jul 11, 2025

Uh oh!

Uh oh!

Copilot AI Jul 11, 2025

Uh oh!

Uh oh!

Uh oh!

baywet Jul 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		var fakeLogger = new FakeLogger<OpenApiDocumentDownloadService>();


		var overlaysPath = Path.GetRandomFileName() + "overlays.yaml";

-        var overlaysPath = Path.GetRandomFileName() + "overlays.yaml";
+        var workingDirectory = Path.Combine(Path.GetTempPath(), "Overlays");
+        Directory.CreateDirectory(workingDirectory);
+        var overlaysPath = Path.Combine(workingDirectory, "overlays.yaml");

		if (Directory.Exists(overlaysPath))
		Directory.Delete(overlaysPath, true);

	Overlays = Overlays
	Overlays = Overlays?.ToHashSet(StringComparer.OrdinalIgnoreCase)

		// TODO : handle multiple Overlays
		var overlay = config.Overlays.First();

Conversation

kilifu commented Jul 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

baywet Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants