| | 1 | | // Copyright DotNet API Diff Project Contributors - SPDX Identifier: MIT |
| | 2 | | namespace DotNetApiDiff.Models; |
| | 3 | |
|
| | 4 | | /// <summary> |
| | 5 | | /// Represents a single API difference between two assemblies |
| | 6 | | /// </summary> |
| | 7 | | public class ApiDifference |
| | 8 | | { |
| | 9 | | /// <summary> |
| | 10 | | /// Type of change detected |
| | 11 | | /// </summary> |
| 285 | 12 | | public ChangeType ChangeType { get; set; } |
| | 13 | |
|
| | 14 | | /// <summary> |
| | 15 | | /// Category of the API element that changed |
| | 16 | | /// </summary> |
| 155 | 17 | | public ApiElementType ElementType { get; set; } |
| | 18 | |
|
| | 19 | | /// <summary> |
| | 20 | | /// Full name of the API element |
| | 21 | | /// </summary> |
| 236 | 22 | | public string ElementName { get; set; } = string.Empty; |
| | 23 | |
|
| | 24 | | /// <summary> |
| | 25 | | /// Description of the change |
| | 26 | | /// </summary> |
| 187 | 27 | | public string Description { get; set; } = string.Empty; |
| | 28 | |
|
| | 29 | | /// <summary> |
| | 30 | | /// Whether this change is considered breaking |
| | 31 | | /// </summary> |
| 220 | 32 | | public bool IsBreakingChange { get; set; } |
| | 33 | |
|
| | 34 | | /// <summary> |
| | 35 | | /// Severity level of the change |
| | 36 | | /// </summary> |
| 100 | 37 | | public SeverityLevel Severity { get; set; } |
| | 38 | |
|
| | 39 | | /// <summary> |
| | 40 | | /// Old signature or value (if applicable) |
| | 41 | | /// </summary> |
| 85 | 42 | | public string? OldSignature { get; set; } |
| | 43 | |
|
| | 44 | | /// <summary> |
| | 45 | | /// New signature or value (if applicable) |
| | 46 | | /// </summary> |
| 81 | 47 | | public string? NewSignature { get; set; } |
| | 48 | | } |