Skip to content

[OpenAPI] Use deduped endpoints for both runtime and document generation #9683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glen-84 merged 1 commit into from
May 12, 2026
Merged

[OpenAPI] Use deduped endpoints for both runtime and document generation #9683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/HotChocolate/Adapters/src/Adapters.OpenApi.Core/OpenApiDefinitionRegistry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,14 +171,13 @@ private void UpdateEndpointsAndOpenApiDefinitions(

var modelsByName = CreateModelsByNameLookup(models);

_transformer.AddDefinitions(endpoints, models, modelsByName, schema);

// When multiple endpoints share (method, route): a descriptor with a valid document
// wins. If no duplicate produces a valid descriptor, the first one whose document
// failed validation is kept so the route is still registered (the middleware returns
// HTTP 500 on call). Descriptors that fail to construct outright are skipped.
// The chosen descriptors are tracked in a list so registration order is deterministic
// (first appearance of each key in `endpoints`, which is already sorted by name).
// Track the chosen definitions in parallel with the descriptors so the same selection
// feeds both the runtime endpoints and the OpenAPI document generation.
var chosenDefinitions = new List<OpenApiEndpointDefinition>();
var chosenDescriptors = new List<OpenApiEndpointDescriptor>();
var keyToIndex = new Dictionary<(string, string), int>();
var keyHasValid = new HashSet<(string, string)>();
Expand Down Expand Up @@ -208,11 +207,13 @@ private void UpdateEndpointsAndOpenApiDefinitions(
if (keyToIndex.TryGetValue(key, out var existingIndex))
{
// Promote: an earlier invalid descriptor is being replaced by a valid one.
chosenDefinitions[existingIndex] = endpoint;
chosenDescriptors[existingIndex] = descriptor;
}
else
{
keyToIndex[key] = chosenDescriptors.Count;
chosenDefinitions.Add(endpoint);
chosenDescriptors.Add(descriptor);
}

Expand All @@ -221,10 +222,13 @@ private void UpdateEndpointsAndOpenApiDefinitions(
else if (!keyToIndex.ContainsKey(key))
{
keyToIndex[key] = chosenDescriptors.Count;
chosenDefinitions.Add(endpoint);
chosenDescriptors.Add(descriptor);
}
}

_transformer.AddDefinitions(chosenDefinitions.ToArray(), models, modelsByName, schema);

var httpEndpoints = new List<Endpoint>();

foreach (var descriptor in chosenDescriptors)
Expand Down
23 changes: 10 additions & 13 deletions ...Api.Tests/OpenApi/__snapshots__/OpenApiIntegrationTestBase.Duplicated_Routes_NET10_0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"paths": {
"/users": {
"get": {
"operationId": "getUsersWithName",
"operationId": "getUsers",
"responses": {
"200": {
"description": null,
Expand All @@ -22,23 +22,20 @@
"type": "array",
"items": {
"required": [
"id",
"name"
"address"
],
"type": "object",
"properties": {
"id": {
"oneOf": [
{
"address": {
"required": [
"street"
],
"type": "object",
"properties": {
"street": {
"type": "string"
},
{
"type": "integer"
}
]
},
"name": {
"type": "string"
}
}
}
}
Expand Down
23 changes: 10 additions & 13 deletions ...nApi.Tests/OpenApi/__snapshots__/OpenApiIntegrationTestBase.Duplicated_Routes_NET9_0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"paths": {
"/users": {
"get": {
"operationId": "getUsersWithName",
"operationId": "getUsers",
"responses": {
"200": {
"description": null,
Expand All @@ -17,23 +17,20 @@
"type": "array",
"items": {
"required": [
"id",
"name"
"address"
],
"type": "object",
"properties": {
"id": {
"oneOf": [
{
"address": {
"required": [
"street"
],
"type": "object",
"properties": {
"street": {
"type": "string"
},
{
"type": "integer"
}
]
},
"name": {
"type": "string"
}
}
}
}
Expand Down
Loading