Skip to content

Fixed crash where the OpenAPI atomic:operations discriminator key isn't unique per schema ID #1776

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
merged 1 commit into from
Aug 24, 2025
Merged

Fixed crash where the OpenAPI atomic:operations discriminator key isn't unique per schema ID #1776

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
46 changes: 23 additions & 23 deletions src/Examples/JsonApiDotNetCoreExample/GeneratedSwagger/JsonApiDotNetCoreExample.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5391,29 +5391,29 @@
"discriminator": {
"propertyName": "openapi:discriminator",
"mapping": {
"addPerson": "#/components/schemas/createPersonOperation",
"addTag": "#/components/schemas/createTagOperation",
"addToPersonAssignedTodoItems": "#/components/schemas/addToPersonAssignedTodoItemsRelationshipOperation",
"addToPersonOwnedTodoItems": "#/components/schemas/addToPersonOwnedTodoItemsRelationshipOperation",
"addToTagTodoItems": "#/components/schemas/addToTagTodoItemsRelationshipOperation",
"addToTodoItemTags": "#/components/schemas/addToTodoItemTagsRelationshipOperation",
"addTodoItem": "#/components/schemas/createTodoItemOperation",
"removeFromPersonAssignedTodoItems": "#/components/schemas/removeFromPersonAssignedTodoItemsRelationshipOperation",
"removeFromPersonOwnedTodoItems": "#/components/schemas/removeFromPersonOwnedTodoItemsRelationshipOperation",
"removeFromTagTodoItems": "#/components/schemas/removeFromTagTodoItemsRelationshipOperation",
"removeFromTodoItemTags": "#/components/schemas/removeFromTodoItemTagsRelationshipOperation",
"removePerson": "#/components/schemas/deletePersonOperation",
"removeTag": "#/components/schemas/deleteTagOperation",
"removeTodoItem": "#/components/schemas/deleteTodoItemOperation",
"updatePerson": "#/components/schemas/updatePersonOperation",
"updatePersonAssignedTodoItems": "#/components/schemas/updatePersonAssignedTodoItemsRelationshipOperation",
"updatePersonOwnedTodoItems": "#/components/schemas/updatePersonOwnedTodoItemsRelationshipOperation",
"updateTag": "#/components/schemas/updateTagOperation",
"updateTagTodoItems": "#/components/schemas/updateTagTodoItemsRelationshipOperation",
"updateTodoItem": "#/components/schemas/updateTodoItemOperation",
"updateTodoItemAssignee": "#/components/schemas/updateTodoItemAssigneeRelationshipOperation",
"updateTodoItemOwner": "#/components/schemas/updateTodoItemOwnerRelationshipOperation",
"updateTodoItemTags": "#/components/schemas/updateTodoItemTagsRelationshipOperation"
"addToPersonAssignedTodoItemsRelationshipOperation": "#/components/schemas/addToPersonAssignedTodoItemsRelationshipOperation",
"addToPersonOwnedTodoItemsRelationshipOperation": "#/components/schemas/addToPersonOwnedTodoItemsRelationshipOperation",
"addToTagTodoItemsRelationshipOperation": "#/components/schemas/addToTagTodoItemsRelationshipOperation",
"addToTodoItemTagsRelationshipOperation": "#/components/schemas/addToTodoItemTagsRelationshipOperation",
"createPersonOperation": "#/components/schemas/createPersonOperation",
"createTagOperation": "#/components/schemas/createTagOperation",
"createTodoItemOperation": "#/components/schemas/createTodoItemOperation",
"deletePersonOperation": "#/components/schemas/deletePersonOperation",
"deleteTagOperation": "#/components/schemas/deleteTagOperation",
"deleteTodoItemOperation": "#/components/schemas/deleteTodoItemOperation",
"removeFromPersonAssignedTodoItemsRelationshipOperation": "#/components/schemas/removeFromPersonAssignedTodoItemsRelationshipOperation",
"removeFromPersonOwnedTodoItemsRelationshipOperation": "#/components/schemas/removeFromPersonOwnedTodoItemsRelationshipOperation",
"removeFromTagTodoItemsRelationshipOperation": "#/components/schemas/removeFromTagTodoItemsRelationshipOperation",
"removeFromTodoItemTagsRelationshipOperation": "#/components/schemas/removeFromTodoItemTagsRelationshipOperation",
"updatePersonAssignedTodoItemsRelationshipOperation": "#/components/schemas/updatePersonAssignedTodoItemsRelationshipOperation",
"updatePersonOperation": "#/components/schemas/updatePersonOperation",
"updatePersonOwnedTodoItemsRelationshipOperation": "#/components/schemas/updatePersonOwnedTodoItemsRelationshipOperation",
"updateTagOperation": "#/components/schemas/updateTagOperation",
"updateTagTodoItemsRelationshipOperation": "#/components/schemas/updateTagTodoItemsRelationshipOperation",
"updateTodoItemAssigneeRelationshipOperation": "#/components/schemas/updateTodoItemAssigneeRelationshipOperation",
"updateTodoItemOperation": "#/components/schemas/updateTodoItemOperation",
"updateTodoItemOwnerRelationshipOperation": "#/components/schemas/updateTodoItemOwnerRelationshipOperation",
"updateTodoItemTagsRelationshipOperation": "#/components/schemas/updateTodoItemTagsRelationshipOperation"
}
},
"x-abstract": true
Expand Down
46 changes: 23 additions & 23 deletions src/Examples/OpenApiKiotaClientExample/GeneratedCode/Models/AtomicOperation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,29 @@ public AtomicOperation()
var mappingValue = parseNode.GetChildNode("openapi:discriminator")?.GetStringValue();
return mappingValue switch
{
"addPerson" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.CreatePersonOperation(),
"addTag" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.CreateTagOperation(),
"addTodoItem" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.CreateTodoItemOperation(),
"addToPersonAssignedTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToPersonAssignedTodoItemsRelationshipOperation(),
"addToPersonOwnedTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToPersonOwnedTodoItemsRelationshipOperation(),
"addToTagTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToTagTodoItemsRelationshipOperation(),
"addToTodoItemTags" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToTodoItemTagsRelationshipOperation(),
"removeFromPersonAssignedTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromPersonAssignedTodoItemsRelationshipOperation(),
"removeFromPersonOwnedTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromPersonOwnedTodoItemsRelationshipOperation(),
"removeFromTagTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromTagTodoItemsRelationshipOperation(),
"removeFromTodoItemTags" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromTodoItemTagsRelationshipOperation(),
"removePerson" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.DeletePersonOperation(),
"removeTag" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.DeleteTagOperation(),
"removeTodoItem" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.DeleteTodoItemOperation(),
"updatePerson" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdatePersonOperation(),
"updatePersonAssignedTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdatePersonAssignedTodoItemsRelationshipOperation(),
"updatePersonOwnedTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdatePersonOwnedTodoItemsRelationshipOperation(),
"updateTag" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTagOperation(),
"updateTagTodoItems" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTagTodoItemsRelationshipOperation(),
"updateTodoItem" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemOperation(),
"updateTodoItemAssignee" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemAssigneeRelationshipOperation(),
"updateTodoItemOwner" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemOwnerRelationshipOperation(),
"updateTodoItemTags" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemTagsRelationshipOperation(),
"addToPersonAssignedTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToPersonAssignedTodoItemsRelationshipOperation(),
"addToPersonOwnedTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToPersonOwnedTodoItemsRelationshipOperation(),
"addToTagTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToTagTodoItemsRelationshipOperation(),
"addToTodoItemTagsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AddToTodoItemTagsRelationshipOperation(),
"createPersonOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.CreatePersonOperation(),
"createTagOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.CreateTagOperation(),
"createTodoItemOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.CreateTodoItemOperation(),
"deletePersonOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.DeletePersonOperation(),
"deleteTagOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.DeleteTagOperation(),
"deleteTodoItemOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.DeleteTodoItemOperation(),
"removeFromPersonAssignedTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromPersonAssignedTodoItemsRelationshipOperation(),
"removeFromPersonOwnedTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromPersonOwnedTodoItemsRelationshipOperation(),
"removeFromTagTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromTagTodoItemsRelationshipOperation(),
"removeFromTodoItemTagsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.RemoveFromTodoItemTagsRelationshipOperation(),
"updatePersonAssignedTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdatePersonAssignedTodoItemsRelationshipOperation(),
"updatePersonOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdatePersonOperation(),
"updatePersonOwnedTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdatePersonOwnedTodoItemsRelationshipOperation(),
"updateTagOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTagOperation(),
"updateTagTodoItemsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTagTodoItemsRelationshipOperation(),
"updateTodoItemAssigneeRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemAssigneeRelationshipOperation(),
"updateTodoItemOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemOperation(),
"updateTodoItemOwnerRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemOwnerRelationshipOperation(),
"updateTodoItemTagsRelationshipOperation" => new global::OpenApiKiotaClientExample.GeneratedCode.Models.UpdateTodoItemTagsRelationshipOperation(),
_ => new global::OpenApiKiotaClientExample.GeneratedCode.Models.AtomicOperation(),
};
}
Expand Down
26 changes: 0 additions & 26 deletions src/JsonApiDotNetCore.OpenApi.Swashbuckle/JsonApiSchemaIdSelector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,6 @@ internal sealed class JsonApiSchemaIdSelector
private const string ResourceTypeSchemaIdTemplate = "[ResourceName] Resource Type";
private const string MetaSchemaIdTemplate = "Meta";

private const string ResourceAtomicOperationDiscriminatorValueTemplate = "[OperationCode] [ResourceName]";
private const string UpdateRelationshipAtomicOperationDiscriminatorValueTemplate = "Update [ResourceName] [RelationshipName]";
private const string AddToRelationshipAtomicOperationDiscriminatorValueTemplate = "Add To [ResourceName] [RelationshipName]";
private const string RemoveFromRelationshipAtomicOperationDiscriminatorValueTemplate = "Remove From [ResourceName] [RelationshipName]";

private const string UpdateRelationshipAtomicOperationSchemaIdTemplate = "Update [ResourceName] [RelationshipName] Relationship Operation";
private const string AddToRelationshipAtomicOperationSchemaIdTemplate = "Add To [ResourceName] [RelationshipName] Relationship Operation";
private const string RemoveFromRelationshipAtomicOperationSchemaIdTemplate = "Remove From [ResourceName] [RelationshipName] Relationship Operation";
Expand Down Expand Up @@ -157,27 +152,6 @@ public string GetAtomicOperationCodeSchemaId(AtomicOperationCode operationCode)
return ApplySchemaTemplate("[OperationCode] Operation Code", null, null, operationCode);
}

public string GetAtomicOperationDiscriminatorValue(AtomicOperationCode operationCode, ResourceType resourceType)
{
ArgumentNullException.ThrowIfNull(resourceType);

return ApplySchemaTemplate(ResourceAtomicOperationDiscriminatorValueTemplate, resourceType, null, operationCode);
}

public string GetAtomicOperationDiscriminatorValue(AtomicOperationCode operationCode, RelationshipAttribute relationship)
{
ArgumentNullException.ThrowIfNull(relationship);

string schemaIdTemplate = operationCode switch
{
AtomicOperationCode.Add => AddToRelationshipAtomicOperationDiscriminatorValueTemplate,
AtomicOperationCode.Remove => RemoveFromRelationshipAtomicOperationDiscriminatorValueTemplate,
_ => UpdateRelationshipAtomicOperationDiscriminatorValueTemplate
};

return ApplySchemaTemplate(schemaIdTemplate, relationship.LeftType, relationship.PublicName, null);
}

public string GetRelationshipAtomicOperationSchemaId(RelationshipAttribute relationship, AtomicOperationCode operationCode)
{
ArgumentNullException.ThrowIfNull(relationship);
Expand Down
10 changes: 4 additions & 6 deletions ...OpenApi.Swashbuckle/SchemaGenerators/Documents/AtomicOperationsDocumentSchemaGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,7 @@ private void GenerateSchemaForResourceOperation(Type operationOpenType, Resource
SetOperationCode(inlineSchemaForOperation, operationCode, schemaRepository);
}

string discriminatorValue = _schemaIdSelector.GetAtomicOperationDiscriminatorValue(operationCode, resourceType);
MapInDiscriminator(referenceSchemaForOperation, discriminatorValue, schemaRepository);
MapInDiscriminator(referenceSchemaForOperation, schemaRepository);

traceScope.TraceSucceeded(referenceSchemaForOperation.Reference.Id);
}
Expand Down Expand Up @@ -264,11 +263,11 @@ private void SetOperationCode(OpenApiSchema fullSchema, AtomicOperationCode oper
fullSchema.Properties[JsonApiPropertyName.Op] = referenceSchema.WrapInExtendedSchema();
}

private static void MapInDiscriminator(OpenApiSchema referenceSchemaForOperation, string discriminatorValue, SchemaRepository schemaRepository)
private static void MapInDiscriminator(OpenApiSchema referenceSchemaForOperation, SchemaRepository schemaRepository)
{
OpenApiSchema referenceSchemaForAbstractOperation = schemaRepository.LookupByType(AtomicOperationAbstractType);
OpenApiSchema fullSchemaForAbstractOperation = schemaRepository.Schemas[referenceSchemaForAbstractOperation.Reference.Id];
fullSchemaForAbstractOperation.Discriminator.Mapping.Add(discriminatorValue, referenceSchemaForOperation.Reference.ReferenceV3);
fullSchemaForAbstractOperation.Discriminator.Mapping.Add(referenceSchemaForOperation.Reference.Id, referenceSchemaForOperation.Reference.ReferenceV3);
}

private static HashSet<RelationshipAttribute> GetRelationshipsInTypeHierarchy(ResourceType baseType)
Expand Down Expand Up @@ -371,8 +370,7 @@ private void GenerateSchemaForRelationshipOperation(Type operationOpenType, Rela
};
}

string discriminatorValue = _schemaIdSelector.GetAtomicOperationDiscriminatorValue(operationCode, relationship);
MapInDiscriminator(referenceSchemaForOperation, discriminatorValue, schemaRepository);
MapInDiscriminator(referenceSchemaForOperation, schemaRepository);

traceScope.TraceSucceeded(schemaId);
}
Expand Down
Loading
Loading