Modernize OpenAPI generation#713
Draft
Copilot wants to merge 9 commits into
Draft
Conversation
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/ea77a270-a4cf-4719-8709-555565079f74 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/ea77a270-a4cf-4719-8709-555565079f74 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/ea77a270-a4cf-4719-8709-555565079f74 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/ea77a270-a4cf-4719-8709-555565079f74 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/ea77a270-a4cf-4719-8709-555565079f74 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
AndreaCuneo
April 27, 2026 06:53
View session
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
AndreaCuneo
requested changes
Apr 27, 2026
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/12e682ba-fd19-4a29-8e7e-ebabcc929815 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/12e682ba-fd19-4a29-8e7e-ebabcc929815 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. 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:
If you need me to access, download, or install something from one of these locations, you can either:
|
AndreaCuneo
requested changes
Apr 27, 2026
Contributor
AndreaCuneo
left a comment
AndreaCuneo
left a comment
There was a problem hiding this comment.
Apply the changes to Ark.Reference project in samples/ to demostrate the migration changes required. Create a step-by-step migration guide.
| { | ||
| base.ConfigureServices(services); | ||
|
|
||
| foreach (var version in Versions) |
Contributor
There was a problem hiding this comment.
this should be in base class and guarded based on the OpenApi enablement
| <Target Name="RemoveReferencedXmlCommentsFromOpenApi" AfterTargets="GenerateAdditionalXmlFilesForOpenApi"> | ||
| <ItemGroup> | ||
| <!-- The Microsoft OpenAPI XML source generator receives referenced project XML files as AdditionalFiles. | ||
| Ark projects include shared Polyfill XML members, which currently produce duplicate XML comment keys. --> |
Contributor
There was a problem hiding this comment.
find alternative solution as xml docs are required to be publish. Consider changing the polyfill configuration.
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/efb0656b-1125-4d27-b1dc-ac2ee95348e2 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
| var baseDirectory = AppContext.BaseDirectory; | ||
| var candidates = new[] | ||
| { | ||
| Path.Combine(baseDirectory, $"{entryAssemblyName}_{documentName}.json"), |
| var candidates = new[] | ||
| { | ||
| Path.Combine(baseDirectory, $"{entryAssemblyName}_{documentName}.json"), | ||
| Path.Combine(baseDirectory, $"{entryAssemblyName}.json"), |
| { | ||
| Path.Combine(baseDirectory, $"{entryAssemblyName}_{documentName}.json"), | ||
| Path.Combine(baseDirectory, $"{entryAssemblyName}.json"), | ||
| Path.Combine(baseDirectory, $"{documentName}.json") |
Comment on lines
+61
to
+65
| foreach (var version in versions) | ||
| { | ||
| var documentName = ToDocumentName(version); | ||
| c.SwaggerEndpoint($@"docs/{documentName}", $@"{documentName} Docs"); | ||
| } |
Comment on lines
+305
to
+311
| foreach (var contentType in response.Content.Keys.ToArray()) | ||
| { | ||
| if (!responseType.ApiResponseFormats.Any(x => string.Equals(x.MediaType, contentType, StringComparison.Ordinal))) | ||
| { | ||
| response.Content.Remove(contentType); | ||
| } | ||
| } |
Comment on lines
+377
to
+383
| foreach (var contentType in content.Keys.ToArray()) | ||
| { | ||
| if (contentType.Contains("odata", StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| content.Remove(contentType); | ||
| } | ||
| } |
Agent-Logs-Url: https://github.com/ARKlab/Ark.Tools/sessions/efb0656b-1125-4d27-b1dc-ac2ee95348e2 Co-authored-by: AndreaCuneo <5227688+AndreaCuneo@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. 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:
If you need me to access, download, or install something from one of these locations, you can either:
|
Comment on lines
+171
to
+208
| foreach (var descriptor in descriptors) | ||
| { | ||
| var propertyInfo = _getPropertyInfo(descriptor); | ||
|
|
||
| if (propertyInfo is null || operation.RequestBody?.Content is null || operation.RequestBody.Content.Count == 0) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var mediaType = operation.RequestBody.Content.First().Value; | ||
|
|
||
| if (mediaType.Schema is not OpenApiSchema schema || schema.Properties is null) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var groupedProperties = schema.Properties | ||
| .GroupBy(pair => pair.Key.Split('.')[0], StringComparer.Ordinal); | ||
|
|
||
| var schemaProperties = new Dictionary<string, IOpenApiSchema>(StringComparer.Ordinal); | ||
|
|
||
| foreach (var property in groupedProperties) | ||
| { | ||
| if (property.Key == propertyInfo.Name) | ||
| { | ||
| _addEncoding(mediaType, propertyInfo); | ||
|
|
||
| var openApiSchema = await _getSchema(context, propertyInfo, cancellationToken).ConfigureAwait(false); | ||
| schemaProperties.Add(property.Key, openApiSchema); | ||
| } | ||
| else | ||
| { | ||
| schemaProperties.Add(property.Key, property.First().Value); | ||
| } | ||
| } | ||
|
|
||
| schema.Properties = schemaProperties; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
UseSwashbuckleOpenApias the legacy opt-in.MapOpenApiare DEBUG-only./swagger/docs/{documentName}.SwaggerOperationAttributeandSwaggerResponseAttribute.Validation
dotnet build Ark.Tools.slnx --no-restoredotnet build samples/WebApplicationDemo/WebApplicationDemo.csproj -c Release --no-restoredotnet build samples/Ark.ReferenceProject/Core/Ark.Reference.Core.WebInterface/Ark.Reference.Core.WebInterface.csproj -c Release --no-restoredotnet test --solution Ark.Tools.slnx --no-build